diff --git a/src/lvgl_win_sim/lv_port_win_codeblocks/music_player_screen.h b/src/lvgl_win_sim/lv_port_win_codeblocks/music_player_screen.h index 2ec2907..01dae9d 100644 --- a/src/lvgl_win_sim/lv_port_win_codeblocks/music_player_screen.h +++ b/src/lvgl_win_sim/lv_port_win_codeblocks/music_player_screen.h @@ -60,6 +60,12 @@ typedef struct MusicPlayerScreen bool ble_connection_state; } MusicPlayerScreen_t; +/** + * @brief Initializes the music player screen's context object + * @note This function has to be called first before any others + * + * @param musicPlayerScreen a pointer to the music player screen's context structure to initialize. + */ void music_player_screen_init(MusicPlayerScreen_t * const musicPlayerScreen); void music_player_screen_register_music_playback_control_cb(MusicPlayerScreen_t * const musicPlayerScreen, MusicPlaybackCtrlCb_t musicPlaybackCtrlCb); @@ -78,8 +84,18 @@ void music_player_screen_set_music_playing_state(MusicPlayerScreen_t * const mus bool music_player_screen_is_in_use(MusicPlayerScreen_t * const musicPlayerScreen); +/** + * @brief Graphically builds the music player screen. + * + * @param musicPlayerScreen a pointer to the music player screen's context structure to initialize. + */ void music_player_screen_create(MusicPlayerScreen_t * const musicPlayerScreen); +/** + * @brief Frees all resources used by the MusicPlayerScreen object. + * + * @param musicPlayerScreen a pointer to the music player screen's context structure to initialize. + */ void music_player_screen_destroy(MusicPlayerScreen_t * const musicPlayerScreen); #endif // MUSIC_PLAYER_SCREEN_H