Kodi Development 23.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
Public Attributes | List of all members
AddonToKodiFuncTable_Game

Game callbacks. More...

Detailed Description

Game callbacks.

Not to be used outside this header.

Public Attributes

void(* AddStreamData )(KODI_HANDLE, KODI_GAME_STREAM_HANDLE, const struct game_stream_packet *)
 
void(* CloseGame )(KODI_HANDLE kodiInstance)
 
void(* CloseStream )(KODI_HANDLE, KODI_GAME_STREAM_HANDLE)
 
bool(* EnableHardwareRendering )(void *, const game_hw_rendering_properties *)
 
double(* GetPlaybackSpeed )(KODI_HANDLE kodiInstance)
 
bool(* GetStreamBuffer )(KODI_HANDLE, KODI_GAME_STREAM_HANDLE, unsigned int, unsigned int, struct game_stream_buffer *)
 
game_proc_address_t(* HwGetProcAddress )(KODI_HANDLE kodiInstance, const char *symbol)
 
bool(* InputEvent )(KODI_HANDLE kodiInstance, const struct game_input_event *event)
 
KODI_HANDLE kodiInstance
 
KODI_GAME_STREAM_HANDLE(* OpenStream )(KODI_HANDLE, const struct game_stream_properties *)
 
void(* RCOnAchievementProgress )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress *progress, unsigned int count)
 
void(* RCOnAchievementProgressHide )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)
 
void(* RCOnAchievementProgressShow )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)
 
void(* RCOnAchievementProgressUpdate )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)
 
void(* RCOnAchievementSets )(KODI_HANDLE kodiInstance, const game_rc_achievement_sets *data)
 Tell Kodi the loaded game's achievement sets, and which set and type each of its achievements has.
 
void(* RCOnAchievementTriggered )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_triggered *data)
 
void(* RCOnChallengeIndicator )(KODI_HANDLE kodiInstance, const struct game_rc_achievement_challenge *data, bool show)
 
void(* RCOnConnectionChanged )(KODI_HANDLE kodiInstance, bool connected)
 
void(* RCOnGameCompleted )(KODI_HANDLE kodiInstance, const char *title, bool hardcore)
 
void(* RCOnGameLoaded )(KODI_HANDLE kodiInstance, const struct game_rc_game_loaded *data)
 
void(* RCOnLeaderboardFailed )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)
 
void(* RCOnLeaderboardScoreboard )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_scoreboard *data)
 
void(* RCOnLeaderboardStarted )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)
 
void(* RCOnLeaderboardSubmitted )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)
 
void(* RCOnLeaderboardTrackerHide )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)
 
void(* RCOnLeaderboardTrackerShow )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)
 
void(* RCOnLeaderboardTrackerUpdate )(KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)
 
void(* RCOnLoginResult )(KODI_HANDLE kodiInstance, const struct game_rc_login_result *data)
 
void(* RCOnReset )(KODI_HANDLE kodiInstance)
 
void(* RCOnRichPresenceUpdated )(KODI_HANDLE kodiInstance, const char *evaluation)
 
void(* RCOnServerError )(KODI_HANDLE kodiInstance, const char *message, const char *api)
 
void(* RCOnSubsetCompleted )(KODI_HANDLE kodiInstance, const char *title)
 
void(* ReleaseStreamBuffer )(KODI_HANDLE, KODI_GAME_STREAM_HANDLE, struct game_stream_buffer *)
 
void(* ReportMissingFile )(KODI_HANDLE kodiInstance, const char *path)
 Name a file the game client looked for and couldn't find.
 
void(* SetFastForwarding )(KODI_HANDLE kodiInstance, bool fastForward, double ratio)
 Ask Kodi to fast-forward, or to stop a fast-forward it asked for.
 
void(* SetGameTiming )(KODI_HANDLE kodiInstance, const struct game_system_timing *timing_info)
 
bool(* StartStream )(KODI_HANDLE, KODI_GAME_STREAM_HANDLE)
 Reset a prepared hardware stream after installing its returned handle.
 

Member Data Documentation

◆ kodiInstance

KODI_HANDLE kodiInstance

◆ EnableHardwareRendering

bool(* EnableHardwareRendering) (void *, const game_hw_rendering_properties *)

◆ CloseGame

void(* CloseGame) (KODI_HANDLE kodiInstance)

◆ GetPlaybackSpeed

double(* GetPlaybackSpeed) (KODI_HANDLE kodiInstance)

◆ SetGameTiming

void(* SetGameTiming) (KODI_HANDLE kodiInstance, const struct game_system_timing *timing_info)

◆ OpenStream

KODI_GAME_STREAM_HANDLE(* OpenStream) (KODI_HANDLE, const struct game_stream_properties *)

◆ GetStreamBuffer

bool(* GetStreamBuffer) (KODI_HANDLE, KODI_GAME_STREAM_HANDLE, unsigned int, unsigned int, struct game_stream_buffer *)

◆ AddStreamData

void(* AddStreamData) (KODI_HANDLE, KODI_GAME_STREAM_HANDLE, const struct game_stream_packet *)

◆ ReleaseStreamBuffer

void(* ReleaseStreamBuffer) (KODI_HANDLE, KODI_GAME_STREAM_HANDLE, struct game_stream_buffer *)

◆ CloseStream

void(* CloseStream) (KODI_HANDLE, KODI_GAME_STREAM_HANDLE)

◆ HwGetProcAddress

game_proc_address_t(* HwGetProcAddress) (KODI_HANDLE kodiInstance, const char *symbol)

◆ InputEvent

bool(* InputEvent) (KODI_HANDLE kodiInstance, const struct game_input_event *event)

◆ RCOnGameLoaded

void(* RCOnGameLoaded) (KODI_HANDLE kodiInstance, const struct game_rc_game_loaded *data)

◆ RCOnAchievementTriggered

void(* RCOnAchievementTriggered) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_triggered *data)

◆ RCOnGameCompleted

void(* RCOnGameCompleted) (KODI_HANDLE kodiInstance, const char *title, bool hardcore)

◆ RCOnRichPresenceUpdated

void(* RCOnRichPresenceUpdated) (KODI_HANDLE kodiInstance, const char *evaluation)

◆ RCOnLoginResult

void(* RCOnLoginResult) (KODI_HANDLE kodiInstance, const struct game_rc_login_result *data)

◆ RCOnAchievementProgress

void(* RCOnAchievementProgress) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress *progress, unsigned int count)

◆ RCOnServerError

void(* RCOnServerError) (KODI_HANDLE kodiInstance, const char *message, const char *api)

◆ RCOnConnectionChanged

void(* RCOnConnectionChanged) (KODI_HANDLE kodiInstance, bool connected)

◆ RCOnChallengeIndicator

void(* RCOnChallengeIndicator) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_challenge *data, bool show)

◆ RCOnAchievementProgressShow

void(* RCOnAchievementProgressShow) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)

◆ RCOnAchievementProgressUpdate

void(* RCOnAchievementProgressUpdate) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)

◆ RCOnAchievementProgressHide

void(* RCOnAchievementProgressHide) (KODI_HANDLE kodiInstance, const struct game_rc_achievement_progress_indicator *data)

◆ RCOnLeaderboardStarted

void(* RCOnLeaderboardStarted) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)

◆ RCOnLeaderboardFailed

void(* RCOnLeaderboardFailed) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)

◆ RCOnLeaderboardSubmitted

void(* RCOnLeaderboardSubmitted) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard *data)

◆ RCOnLeaderboardTrackerShow

void(* RCOnLeaderboardTrackerShow) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)

◆ RCOnLeaderboardTrackerUpdate

void(* RCOnLeaderboardTrackerUpdate) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)

◆ RCOnLeaderboardTrackerHide

void(* RCOnLeaderboardTrackerHide) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_tracker *data)

◆ RCOnLeaderboardScoreboard

void(* RCOnLeaderboardScoreboard) (KODI_HANDLE kodiInstance, const struct game_rc_leaderboard_scoreboard *data)

◆ RCOnReset

void(* RCOnReset) (KODI_HANDLE kodiInstance)

◆ RCOnSubsetCompleted

void(* RCOnSubsetCompleted) (KODI_HANDLE kodiInstance, const char *title)

◆ StartStream

bool(* StartStream) (KODI_HANDLE, KODI_GAME_STREAM_HANDLE)

Reset a prepared hardware stream after installing its returned handle.

OpenStream creates the context and framebuffer without calling the add-on. Call StartStream after storing that handle, so HwContextReset can acquire a framebuffer. Repeated calls do not reset again. On failure, CloseStream must release the handle; Kodi calls HwContextDestroy before teardown.

◆ ReportMissingFile

void(* ReportMissingFile) (KODI_HANDLE kodiInstance, const char *path)

Name a file the game client looked for and couldn't find.

Call it before returning GAME_ERROR_MISSING_FILES. The path is relative to the client's system directory. Since game API 8.3.0.

◆ SetFastForwarding

void(* SetFastForwarding) (KODI_HANDLE kodiInstance, bool fastForward, double ratio)

Ask Kodi to fast-forward, or to stop a fast-forward it asked for.

A ratio above 1 is the speed asked for; anything else leaves it to Kodi. Since game API 8.4.0.

◆ RCOnAchievementSets

void(* RCOnAchievementSets) (KODI_HANDLE kodiInstance, const game_rc_achievement_sets *data)

Tell Kodi the loaded game's achievement sets, and which set and type each of its achievements has.

Call it after RCOnGameLoaded(). Since game API 8.5.0.

The documentation for this struct was generated from the following file: