Introduce Debug Logging

[123mpozzi]

Description

Debug logging provides detailed information primarily for debugging purposes, helping to diagnose problems and trace the flow of execution within the Player.

Changes

New static APIs to check and set whether debug logging is enabled:

• isDebugLoggingEnabled
• setDebugLogging(value: boolean)

Internally, this has been handled by adding a new module, because this is not a config like the others since it is static/global.

Test and Basic Usage

Important

For iOS, Use player version 3.77.3-a.1 or newer

Add the following to BasicPlayback:

// other imports ...
import { useTVGestures } from '../hooks';

+ DebugConfig.setDebugLogging(true); // Add it right after the imports

Can also leverage a player event to test the flag:

  const onPaused = useCallback((_: Event) => {
    if (DebugConfig.isDebugLoggingEnabled) {
      DebugConfig.setDebugLogging(false);
    } else {
      DebugConfig.setDebugLogging(true);
    }
  }, []);

Changing flag value after initialization, however, does not work for Android because of a limitation

Checklist

• 🗒 CHANGELOG entry

[123mpozzi]

We should merge only after iOS SDK version 3.78.0 is used in the project

[rolandkakonyi]

Changes and testing looks good!

[123mpozzi]

TypeDoc note: I've discovered we can use @defaultValue 😮