Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

YoutubePlayablesClient

Inherits: ThirdPartyClient < Node < Object

Node for using the Youtube Playables SDK.

Description

Node for using the Youtube Playables SDK.

Implementation based on the official Youtube Playables SDK. Official documentation for this service on developers.google.com/youtube/gaming/playables/reference/sdk.

You can test your game on developers.google.com/youtube/gaming/playables/test_suite.

Methods

YoutubePlayablesResponse	get_language()
String	get_sdk_version()
bool	is_audio_enabled()
bool	is_youtube_environment()
YoutubePlayablesResponse	load_data()
void	log_error()
void	log_warning()
YoutubePlayablesResponse	open_yt_content(video_id: String)
YoutubePlayablesResponse	save_data(data: String)
YoutubePlayablesResponse	send_score(value: int)

---

Signals

audio_enabled_change(enabled: bool) 🔗

Emitted when the audio settings change event is fired from YouTube.

Mute toggle requirements.

---

pause() 🔗

Emitted when a pause game event is fired from YouTube.

When a pause game event is fired from YouTube, audio_enabled_change is emitted.

Note: You have a short window to save any state before your game gets evicted.

Pause and resume requirements.

---

resume() 🔗

Emitted when a resume game event is fired from YouTube.

When a resume game event is fired from YouTube, audio_enabled_change is emitted.

Pause and resume requirements.

---

Method Descriptions

YoutubePlayablesResponse get_language() 🔗

Returns the BCP-47 language tag for the user's language set in YouTube.

Note: this may be different than the system or browser language settings but should always match the language used in YouTube.

Returns an empty String if called outside the Youtube Playables environment.

---

String get_sdk_version() 🔗

The YouTube Playables SDK version.

Returns an empty String if called outside the Youtube Playables environment.

---

bool is_audio_enabled() 🔗

Returns whether the game audio is enabled in the YouTube settings.

Returns true if called outside the Youtube Playables environment.

---

bool is_youtube_environment() 🔗

Whether or not the game is running as a playable.

GDScript

if is_youtube_environment():
    print("Youtube Playables SDK version is " + get_sdk_version())

---

YoutubePlayablesResponse load_data() 🔗

Loads game data from the YouTube cloud in the form of a serialized string. This API is usually called before the game loads to resume the game state.

GDScript

var result: YoutubePlayablesResponse = await load_data().finished
if result.has_error():
    push_error(result.error)
    log_error()
else:
    var data: Dictionary = JSON.parse_string(result.data)
    print("Player is at level %d." % data["player_level"])

Note: Signed-out players are not supported. The YoutubePlayablesResult.data will be empty.

Cloud saves requirements.

---

void log_error() 🔗

Logs an error to YouTube.

Note: This API is best-effort and rate-limited which can result in data loss.

---

void log_warning() 🔗

Logs a warning to YouTube.

Note: This API is best-effort and rate-limited which can result in data loss.

---

YoutubePlayablesResponse open_yt_content(video_id: String) 🔗

Open a YouTube video given a valid video_id.

This will open the video in a new tab on web and in the miniplayer on mobile.

---

YoutubePlayablesResponse save_data(data: String) 🔗

Saves game data to the YouTube cloud in the form of a serialized string.

It is recommended to save your data immediately after important milestones.

GDScript

var data: Dictionary = {"player_level": 42}
var result: YoutubePlayablesResult = await save_data(JSON.stringify(data)).finished
if result.has_error():
    push_error(result.error)
    log_error()

Note: Signed-out players are not supported. YoutubePlayablesResponse.finished returns without errors but the data is not be saved.

Cloud saves requirements.

---

YoutubePlayablesResponse send_score(value: int) 🔗

Sends the user's best score to YouTube.

The score should represent one dimension of progress within the game. If there are multiple dimensions, the developer must choose one dimension to be consistent. Scores will be sorted and the highest score will be displayed in YouTube UI so any in-game high score UI should align with what is being sent through this API.

User scores requirements.