.jazzy.yaml

author: John Fairhurst
author_url: http://github.com/johnfairh
copyright: Distributed under the MIT license.  Maintained by [John Fairhurst](mailto:johnfairh@gmail.com).
readme: README.md
products:
  - docs
code_host: github
code_host_url: https://github.com/johnfairh/swift-steamworks
code_host_file_url: https://github.com/johnfairh/swift-steamworks/blob/main
clean: true
sdk: macosx
theme: fw2020
deployment_url: https://johnfairh.github.io/swift-steamworks/
build_tool: spm
modules:
  - Steamworks
  - SteamworksHelpers
  - SteamworksConcurrency
  - SteamworksEncryptedAppTicket
build_tool_arguments:
  - "-Xswiftc"
  - "-I${PWD}/sdk/public"
  - "-Xlinker"
  - "-lc++"
title: Steamworks v1.1.0
module_version: 1.1.0
topic_style: source-order-defs
hide_coverage: true
undocumented_text: ""
custom_groups:
# paste
  - name: API Clients
    topics:
    - name: Clients
      children:
        - SteamBaseAPI
        - SteamAPI
        - SteamGameServerAPI
        - SteamEncryptedAppTicket
        - SteamExecutor
  - name: SteamApps
    topics:
    - name: Interfaces
      children:
        - SteamApps
    - name: Structures
      children:
        - FileDetailsResult
    - name: Callbacks
      children:
        - AppProofOfPurchaseKeyResponse
        - DlcInstalled
        - NewUrlLaunchParameters
        - TimedTrialStatus
  - name: SteamFriends
    topics:
    - name: Interfaces
      children:
        - SteamFriends
    - name: Simple types
      children:
        - FriendsGroupID
    - name: Enumerations and Option Sets
      children:
        - ActivateGameOverlayToWebPageMode
        - CommunityProfileItemProperty
        - CommunityProfileItemType
        - FriendFlags
        - FriendRelationship
        - OverlayToStoreFlag
        - PersonaChange
        - PersonaState
        - UserRestriction
    - name: Structures
      children:
        - ClanOfficerListResponse
        - DownloadClanActivityCountsResult
        - EquippedProfileItems
        - FriendGameInfo
        - FriendsEnumerateFollowingList
        - FriendsGetFollowerCount
        - FriendsIsFollowing
        - JoinClanChatRoomCompletionResult
        - SetPersonaNameResponse
    - name: Callbacks
      children:
        - AvatarImageLoaded
        - EquippedProfileItemsChanged
        - FriendRichPresenceUpdate
        - GameConnectedChatJoin
        - GameConnectedChatLeave
        - GameConnectedClanChatMsg
        - GameConnectedFriendChatMsg
        - GameLobbyJoinRequested
        - GameOverlayActivated
        - GameRichPresenceJoinRequested
        - GameServerChangeRequested
        - OverlayBrowserProtocolNavigation
        - PersonaStateChange
        - UnreadChatMessagesChanged
  - name: SteamGameSearch
    topics:
    - name: Interfaces
      children:
        - SteamGameSearch
    - name: Enumerations and Option Sets
      children:
        - ChatMemberStateChange
        - PlayerAcceptState
    - name: Callbacks
      children:
        - EndGameResultCallback
        - RequestPlayersForGameFinalResultCallback
        - RequestPlayersForGameProgressCallback
        - RequestPlayersForGameResultCallback
        - SearchForGameProgressCallback
        - SearchForGameResultCallback
        - SubmitPlayerResultResultCallback
  - name: SteamGameServer
    topics:
    - name: Interfaces
      children:
        - SteamGameServer
    - name: Structures
      children:
        - AssociateWithClanResult
        - ComputeNewPlayerCompatibilityResult
        - GSReputation
    - name: Callbacks
      children:
        - GSClientAchievementStatus
        - GSClientApprove
        - GSClientDeny
        - GSClientGroupStatus
        - GSClientKick
        - GSGameplayStats
        - GSPolicyResponse
  - name: SteamGameServerStats
    topics:
    - name: Interfaces
      children:
        - SteamGameServerStats
    - name: Structures
      children:
        - GSStatsReceived
        - GSStatsStored
    - name: Callbacks
      children:
        - GSStatsUnloaded
  - name: SteamHTMLSurface
    topics:
    - name: Interfaces
      children:
        - SteamHTMLSurface
    - name: Simple types
      children:
        - HHTMLBrowser
    - name: Enumerations and Option Sets
      children:
        - HTMLKeyModifiers
        - HTMLMouseButton
        - HTMLMouseCursor
    - name: Structures
      children:
        - HTMLBrowserReady
    - name: Callbacks
      children:
        - HTMLBrowserRestarted
        - HTMLCanGoBackAndForward
        - HTMLChangedTitle
        - HTMLCloseBrowser
        - HTMLFileOpenDialog
        - HTMLFinishedRequest
        - HTMLHideToolTip
        - HTMLHorizontalScroll
        - HTMLJSAlert
        - HTMLJSConfirm
        - HTMLLinkAtPosition
        - HTMLNeedsPaint
        - HTMLNewWindow
        - HTMLOpenLinkInNewTab
        - HTMLSearchResults
        - HTMLSetCursor
        - HTMLShowToolTip
        - HTMLStartRequest
        - HTMLStatusText
        - HTMLURLChanged
        - HTMLUpdateToolTip
        - HTMLVerticalScroll
  - name: SteamHTTP
    topics:
    - name: Interfaces
      children:
        - SteamHTTP
    - name: Simple types
      children:
        - HTTPCookieContainerHandle
        - HTTPRequestHandle
    - name: Enumerations and Option Sets
      children:
        - HTTPMethod
        - HTTPStatusCode
    - name: Structures
      children:
        - HTTPRequestCompleted
    - name: Callbacks
      children:
        - HTTPRequestDataReceived
        - HTTPRequestHeadersReceived
  - name: SteamInput
    topics:
    - name: Interfaces
      children:
        - SteamInput
    - name: Simple types
      children:
        - InputActionSetHandle
        - InputAnalogActionHandle
        - InputDigitalActionHandle
        - InputHandle
        - SteamInputActionEventCallbackPointer
    - name: Enumerations and Option Sets
      children:
        - ControllerHapticLocation
        - ControllerHapticType
        - InputActionOrigin
        - InputSourceMode
        - SteamControllerPad
        - SteamInputActionEventType
        - SteamInputConfigurationEnableType
        - SteamInputGlyphSize
        - SteamInputGlyphStyle
        - SteamInputLEDFlag
        - SteamInputType
        - XboxOrigin
    - name: Structures
      children:
        - InputAnalogActionData
        - InputDigitalActionData
        - InputMotionData
        - SteamInputActionEvent
    - name: Callbacks
      children:
        - SteamInputConfigurationLoaded
        - SteamInputDeviceConnected
        - SteamInputDeviceDisconnected
        - SteamInputGamepadSlotChange
  - name: SteamInventory
    topics:
    - name: Interfaces
      children:
        - SteamInventory
    - name: Simple types
      children:
        - SteamInventoryResult
        - SteamInventoryUpdateHandle
        - SteamItemDef
        - SteamItemInstanceID
    - name: Enumerations and Option Sets
      children:
        - SteamItemFlags
    - name: Structures
      children:
        - SteamInventoryEligiblePromoItemDefIDs
        - SteamInventoryRequestPricesResult
        - SteamInventoryStartPurchaseResult
        - SteamItemDetails
    - name: Callbacks
      children:
        - SteamInventoryDefinitionUpdate
        - SteamInventoryFullUpdate
        - SteamInventoryResultReady
  - name: SteamMatchmaking
    topics:
    - name: Interfaces
      children:
        - SteamMatchmaking
    - name: Simple types
      children:
        - MatchMakingKeyValuePairs
    - name: Enumerations and Option Sets
      children:
        - FavoriteFlags
        - LobbyComparison
        - LobbyDistanceFilter
        - LobbyType
        - MatchMakingServerResponse
    - name: Structures
      children:
        - GameServerItem
        - LobbyCreated
        - LobbyMatchList
        - ServerNetAdr
    - name: Callbacks
      children:
        - FavoritesListAccountsUpdated
        - FavoritesListChanged
        - LobbyChatMsg
        - LobbyChatUpdate
        - LobbyDataUpdate
        - LobbyEnter
        - LobbyGameCreated
        - LobbyInvite
        - LobbyKicked
        - PSNGameBootInviteResult
  - name: SteamMatchmakingServers
    topics:
    - name: Interfaces
      children:
        - SteamMatchmakingServers
    - name: Simple types
      children:
        - HServerListRequest
        - HServerQuery
    - name: Protocols
      children:
        - SteamMatchmakingPingResponse
        - SteamMatchmakingPlayersResponse
        - SteamMatchmakingRulesResponse
        - SteamMatchmakingServerListResponse
  - name: SteamMusic
    topics:
    - name: Interfaces
      children:
        - SteamMusic
    - name: Enumerations and Option Sets
      children:
        - AudioPlaybackStatus
    - name: Callbacks
      children:
        - PlaybackStatusHasChanged
        - VolumeHasChanged
  - name: SteamMusicRemote
    topics:
    - name: Interfaces
      children:
        - SteamMusicRemote
    - name: Callbacks
      children:
        - MusicPlayerRemoteToFront
        - MusicPlayerRemoteWillActivate
        - MusicPlayerRemoteWillDeactivate
        - MusicPlayerSelectsPlaylistEntry
        - MusicPlayerSelectsQueueEntry
        - MusicPlayerWantsLooped
        - MusicPlayerWantsPause
        - MusicPlayerWantsPlay
        - MusicPlayerWantsPlayNext
        - MusicPlayerWantsPlayPrevious
        - MusicPlayerWantsPlayingRepeatStatus
        - MusicPlayerWantsShuffled
        - MusicPlayerWantsVolume
        - MusicPlayerWillQuit
  - name: SteamNetworkingMessages
    topics:
    - name: Interfaces
      children:
        - SteamNetworkingMessages
    - name: Callbacks
      children:
        - SteamNetworkingMessagesSessionFailed
        - SteamNetworkingMessagesSessionRequest
  - name: SteamNetworkingSockets
    topics:
    - name: Interfaces
      children:
        - SteamNetworkingFakeUDPPort
        - SteamNetworkingSockets
    - name: Callbacks
      children:
        - SteamNetAuthenticationStatus
        - SteamNetConnectionStatusChangedCallback
        - SteamNetworkingFakeIPResult
  - name: SteamNetworkingUtils
    topics:
    - name: Interfaces
      children:
        - SteamNetworkingUtils
    - name: Simple types
      children:
        - HSteamListenSocket
        - HSteamNetConnection
        - HSteamNetPollGroup
        - SteamNetworkingErrMsg
        - SteamNetworkingMicroseconds
        - SteamNetworkingPOPID
    - name: Enumerations and Option Sets
      children:
        - SteamNetConnectionEnd
        - SteamNetworkConnectionInfoFlags
        - SteamNetworkingAvailability
        - SteamNetworkingConfigDataType
        - SteamNetworkingConfigScope
        - SteamNetworkingConfigValueSetting
        - SteamNetworkingConnectionState
        - SteamNetworkingFakeIPType
        - SteamNetworkingGetConfigValueResult
        - SteamNetworkingIdentityType
        - SteamNetworkingSendFlags
        - SteamNetworkingSocketsDebugOutputType
    - name: Structures
      children:
        - SteamNetConnectionInfo
        - SteamNetConnectionRealTimeLaneStatus
        - SteamNetConnectionRealTimeStatus
        - SteamNetworkPingLocation
        - SteamNetworkingConfigValue
        - SteamNetworkingIPAddr
        - SteamNetworkingIdentity
        - SteamNetworkingMessage
    - name: Callbacks
      children:
        - SteamRelayNetworkStatus
  - name: SteamParentalSettings
    topics:
    - name: Interfaces
      children:
        - SteamParentalSettings
    - name: Enumerations and Option Sets
      children:
        - ParentalFeature
    - name: Callbacks
      children:
        - SteamParentalSettingsChanged
  - name: SteamParties
    topics:
    - name: Interfaces
      children:
        - SteamParties
    - name: Enumerations and Option Sets
      children:
        - SteamPartyBeaconLocationData
        - SteamPartyBeaconLocationType
    - name: Structures
      children:
        - ChangeNumOpenSlotsCallback
        - CreateBeaconCallback
        - JoinPartyCallback
        - SteamPartyBeaconLocation
    - name: Callbacks
      children:
        - ActiveBeaconsUpdated
        - AvailableBeaconLocationsUpdated
        - ReservationNotificationCallback
  - name: SteamRemotePlay
    topics:
    - name: Interfaces
      children:
        - SteamRemotePlay
    - name: Simple types
      children:
        - RemotePlaySessionID
    - name: Enumerations and Option Sets
      children:
        - SteamDeviceFormFactor
    - name: Callbacks
      children:
        - SteamRemotePlaySessionConnected
        - SteamRemotePlaySessionDisconnected
        - SteamRemotePlayTogetherGuestInvite
  - name: SteamRemoteStorage
    topics:
    - name: Interfaces
      children:
        - SteamRemoteStorage
    - name: Simple types
      children:
        - PublishedFileID
        - PublishedFileUpdateHandle
        - UGCFileWriteStreamHandle
        - UGCHandle
    - name: Enumerations and Option Sets
      children:
        - RemoteStorageFilePathType
        - RemoteStorageLocalFileChangeType
        - RemoteStoragePlatform
        - RemoteStoragePublishedFileVisibility
        - UGCReadAction
        - WorkshopEnumerationType
        - WorkshopFileAction
        - WorkshopFileType
        - WorkshopVideoProvider
        - WorkshopVote
    - name: Structures
      children:
        - RemoteStorageDeletePublishedFileResult
        - RemoteStorageDownloadUGCResult
        - RemoteStorageEnumeratePublishedFilesByUserActionResult
        - RemoteStorageEnumerateUserPublishedFilesResult
        - RemoteStorageEnumerateUserSubscribedFilesResult
        - RemoteStorageEnumerateWorkshopFilesResult
        - RemoteStorageFileReadAsyncComplete
        - RemoteStorageFileShareResult
        - RemoteStorageFileWriteAsyncComplete
        - RemoteStorageGetPublishedFileDetailsResult
        - RemoteStorageGetPublishedItemVoteDetailsResult
        - RemoteStoragePublishFileProgress
        - RemoteStorageSetUserPublishedFileActionResult
        - RemoteStorageSubscribePublishedFileResult
        - RemoteStorageUnsubscribePublishedFileResult
        - RemoteStorageUpdatePublishedFileResult
        - RemoteStorageUpdateUserPublishedItemVoteResult
    - name: Callbacks
      children:
        - RemoteStorageEnumerateUserSharedWorkshopFilesResult
        - RemoteStorageLocalFileChange
        - RemoteStoragePublishFileResult
        - RemoteStoragePublishedFileDeleted
        - RemoteStoragePublishedFileSubscribed
        - RemoteStoragePublishedFileUnsubscribed
        - RemoteStoragePublishedFileUpdated
        - RemoteStorageUserVoteDetails
  - name: SteamScreenshots
    topics:
    - name: Interfaces
      children:
        - SteamScreenshots
    - name: Simple types
      children:
        - ScreenshotHandle
    - name: Enumerations and Option Sets
      children:
        - VRScreenshotType
    - name: Callbacks
      children:
        - ScreenshotReady
        - ScreenshotRequested
  - name: SteamTimeline
    topics:
    - name: Interfaces
      children:
        - SteamTimeline
    - name: Simple types
      children:
        - TimelineEventHandle
    - name: Enumerations and Option Sets
      children:
        - TimelineEventClipPriority
        - TimelineGameMode
    - name: Structures
      children:
        - SteamTimelineEventRecordingExists
        - SteamTimelineGamePhaseRecordingExists
  - name: SteamUGC
    topics:
    - name: Interfaces
      children:
        - SteamUGC
    - name: Simple types
      children:
        - UGCQueryHandle
        - UGCUpdateHandle
    - name: Enumerations and Option Sets
      children:
        - ItemPreviewType
        - ItemState
        - ItemStatistic
        - ItemUpdateStatus
        - UGCContentDescriptorID
        - UGCMatchingUGCType
        - UGCQuery
        - UserUGCList
        - UserUGCListSortOrder
    - name: Structures
      children:
        - AddAppDependencyResult
        - AddUGCDependencyResult
        - CreateItemResult
        - DeleteItemResult
        - GetAppDependenciesResult
        - GetUserItemVoteResult
        - RemoveAppDependencyResult
        - RemoveUGCDependencyResult
        - SetUserItemVoteResult
        - StartPlaytimeTrackingResult
        - SteamUGCDetails
        - SteamUGCQueryCompleted
        - SteamUGCRequestUGCDetailsResult
        - StopPlaytimeTrackingResult
        - SubmitItemUpdateResult
        - UserFavoriteItemsListChanged
        - WorkshopEULAStatus
    - name: Callbacks
      children:
        - DownloadItemResult
        - ItemInstalled
        - UserSubscribedItemsListChanged
  - name: SteamUser
    topics:
    - name: Interfaces
      children:
        - SteamUser
    - name: Enumerations and Option Sets
      children:
        - IPCFailureType
    - name: Structures
      children:
        - EncryptedAppTicketResponse
        - MarketEligibilityResponse
        - StoreAuthURLResponse
    - name: Callbacks
      children:
        - ClientGameServerDeny
        - DurationControl
        - GameWebCallback
        - GetAuthSessionTicketResponse
        - GetTicketForWebApiResponse
        - IPCFailure
        - LicensesUpdated
        - MicroTxnAuthorizationResponse
        - SteamServerConnectFailure
        - SteamServersConnected
        - SteamServersDisconnected
        - ValidateAuthTicketResponse
  - name: SteamUserStats
    topics:
    - name: Interfaces
      children:
        - SteamUserStats
    - name: Simple types
      children:
        - SteamLeaderboard
        - SteamLeaderboardEntries
    - name: Enumerations and Option Sets
      children:
        - LeaderboardDataRequest
        - LeaderboardDisplayType
        - LeaderboardSortMethod
        - LeaderboardUploadScoreMethod
    - name: Structures
      children:
        - GlobalAchievementPercentagesReady
        - GlobalStatsReceived
        - LeaderboardEntry
        - LeaderboardFindResult
        - LeaderboardScoreUploaded
        - LeaderboardScoresDownloaded
        - LeaderboardUGCSet
        - NumberOfCurrentPlayers
        - UserStatsReceived
    - name: Callbacks
      children:
        - PS3TrophiesInstalled
        - UserAchievementIconFetched
        - UserAchievementStored
        - UserStatsStored
        - UserStatsUnloaded
  - name: SteamUtils
    topics:
    - name: Interfaces
      children:
        - SteamUtils
    - name: Enumerations and Option Sets
      children:
        - CheckFileSignatureResult
        - FloatingGamepadTextInputMode
        - GamepadTextInputLineMode
        - GamepadTextInputMode
        - SteamAPICallFailure
        - TextFilteringContext
    - name: Structures
      children:
        - CheckFileSignature
    - name: Callbacks
      children:
        - AppResumingFromSuspend
        - FilterTextDictionaryChanged
        - FloatingGamepadTextInputDismissed
        - GamepadTextInputDismissed
        - IPCountry
        - LowBatteryPower
        - SteamAPICallCompleted
        - SteamShutdown
  - name: SteamVideo
    topics:
    - name: Interfaces
      children:
        - SteamVideo
    - name: Callbacks
      children:
        - BroadcastUploadStart
        - BroadcastUploadStop
        - GetOPFSettingsResult
        - GetVideoURLResult
  - name: Common Types
    topics:
    - name: Simple types
      children:
        - AccountID
        - AppID
        - DepotID
        - HAuthTicket
        - HSteamPipe
        - HSteamUser
        - PartyBeaconID
        - RTime32
        - SteamAPICall
        - SteamAPIWarningMessageHook
        - SteamErrMsg
        - SteamUnsafeMutablePointer
        - SteamUnsafeMutableRawPointer
        - SteamUnsafeRawPointer
    - name: Enumerations and Option Sets
      children:
        - AccountType
        - AuthSessionResponse
        - BeginAuthSessionResult
        - BetaBranchFlags
        - BroadcastUploadResult
        - ChatEntryType
        - ChatRoomEnterResponse
        - ChatSteamIDInstanceFlags
        - DenyReason
        - DurationControlNotification
        - DurationControlOnlineState
        - DurationControlProgress
        - GameSearchErrorCode
        - MarketNotAllowedReasonFlags
        - NotificationPosition
        - PlayerResult
        - Result
        - ServerMode
        - SteamAPIInitResult
        - SteamIPType
        - SteamIPv6ConnectivityProtocol
        - SteamIPv6ConnectivityState
        - Universe
        - UserHasLicenseForAppResult
        - VoiceResult
    - name: Structures
      children:
        - GameID
        - SteamID
        - SteamIPAddress
        - SteamUncheckedSendable
  - name: Constants
    topics:
    - name: Constants
      children:
        - SteamConstants