ExoPlayerLogger.java

Overview

`ExoPlayerLogger.java` is a utility class designed to provide centralized and configurable logging capabilities specifically for components that interact with the ExoPlayer media playback library. It acts as a lightweight wrapper around the Android `Log` class, enabling developers to control logging output dynamically via a single static flag. This approach simplifies toggling debug information during development and testing without modifying multiple logging statements throughout the codebase.

The class supports all standard Android log levels — debug, info, warning, error, and verbose — and is intended primarily for internal use within the media playback system to trace player states, errors, and other runtime events.

Class: ExoPlayerLogger

Description

A utility class that conditionally outputs log messages depending on the state of the `SHOW_LOGGING` flag. It provides static methods corresponding to Android's log levels, each accepting a log tag and a message.

Properties

Methods

All methods are **static** and provide conditional logging at different levels.

d(String tag, String message)

• Purpose: Writes a debug-level log message if logging is enabled.

• Parameters:

  • tag - A String representing the log tag (usually the class or component name).

  • message - The debug message to log.

• Return: void

• Usage Example:

  ExoPlayerLogger.d("PlayerEvent", "Player state changed to READY");
  

• Behavior: Calls Log.d(tag, message) when SHOW_LOGGING is true. Otherwise, does nothing.

i(String tag, String message)

• Purpose: Writes an info-level log message if logging is enabled.

• Parameters:

  • tag - Log tag.

  • message - Info message.

• Return: void

• Usage Example:

  ExoPlayerLogger.i("Network", "Buffering started");
  

• Behavior: Calls Log.i(tag, message) conditionally.

w(String tag, String message)

• Purpose: Writes a warning-level log message if logging is enabled.

• Parameters:

  • tag - Log tag.

  • message - Warning message.

• Return: void

• Usage Example:

  ExoPlayerLogger.w("Playback", "Unexpected buffering event");
  

• Behavior: Calls Log.w(tag, message) conditionally.

e(String tag, String message)

• Purpose: Writes an error-level log message if logging is enabled.

• Parameters:

  • tag - Log tag.

  • message - Error message.

• Return: void

• Usage Example:

  ExoPlayerLogger.e("Decoder", "Failed to decode frame");
  

• Behavior: Calls Log.e(tag, message) conditionally.

v(String tag, String message)

• Purpose: Writes a verbose-level log message if logging is enabled.

• Parameters:

  • tag - Log tag.

  • message - Verbose message.

• Return: void

• Usage Example:

  ExoPlayerLogger.v("MediaSource", "Loading media source details");
  

• Behavior: Calls Log.v(tag, message) conditionally.

Important Implementation Details

• Global Logging Toggle:
  The SHOW_LOGGING boolean flag allows enabling or disabling all logs emitted by this class without changing any calls to logging methods throughout the codebase. This feature is useful for controlling log verbosity in different build environments (e.g., debug vs. release).

• Static Utility Design:
  All methods and the flag are static, reflecting the utility nature of the class. There is no need to instantiate ExoPlayerLogger.

• Minimal Overhead:
  When logging is disabled (SHOW_LOGGING == false), the methods return immediately, avoiding unnecessary string concatenations or method calls to Android's Log class, thus improving performance.

• No Log Filtering or Formatting:
  This class does not provide advanced features like log filtering by tag, formatting, or asynchronous logging. It delegates all such concerns to Android's built-in Log class.

Usage Context and Integration

• Role in the System:
  ExoPlayerLogger is used as a centralized logging utility within the media playback system, particularly for components interacting with ExoPlayer, such as FSM states, media source handlers, or playback controllers.

• Integration with Other Components:

  • FSM Player and Playback States: Logging state transitions, inputs, or errors during playback lifecycle.

  • EventLogger (from the same topic): While EventLogger listens to ExoPlayer events and logs detailed analytics, ExoPlayerLogger provides straightforward logging calls for ad hoc messages or debug points.

  • UI and User Interaction: May be used to log user-triggered playback events or errors.

  • Testing and Debugging: Enables developers and testers to enable verbose logging during development or debugging sessions without changing core logic.

• Configuration:
  The SHOW_LOGGING flag can be toggled programmatically or potentially linked to build configurations to switch logging on/off for different environments.

Example Usage

public class MediaPlayerController {

    private static final String TAG = "MediaPlayerController";

    public void onPlayerReady() {
        ExoPlayerLogger.d(TAG, "Player is ready to play.");
    }

    public void onError(Exception e) {
        ExoPlayerLogger.e(TAG, "Playback error: " + e.getMessage());
    }

    public void onBufferingStart() {
        ExoPlayerLogger.i(TAG, "Buffering started.");
    }
}

Mermaid Diagram

classDiagram
    class ExoPlayerLogger {
        <<utility>>
        +Boolean SHOW_LOGGING
        +d(String tag, String message) void
        +i(String tag, String message) void
        +w(String tag, String message) void
        +e(String tag, String message) void
        +v(String tag, String message) void
    }

Summary

`ExoPlayerLogger.java` provides a simple, effective, and consistent logging mechanism tailored for ExoPlayer-related components. It enables dynamic control of logging output, allowing developers to trace the flow of playback events, state changes, and errors without cluttering production logs. Its design as a static utility class ensures low overhead and ease of use across the media playback codebase.

In the broader project, it complements more sophisticated logging and analytics tools like `EventLogger` by offering lightweight, flexible logging calls useful during development, debugging, and unit testing. Together, these logging utilities enhance the maintainability, reliability, and observability of the media playback system.