Home

PixelPlay API Docs 📺

Basic Usage

import me.javivi.pp.api.PixelPlayAPI;

// Check if API is ready
if (PixelPlayAPI.isReady()) {
    PixelPlayAPI.startVideo("https://javivi.dev/video.mp4", false);
}

API Reference

Video Playback

startVideo(String url, boolean freezeScreen)

Starts a simple video without effects.

Parameters:

• url - Video URL (YouTube, direct MP4, etc.)
• freezeScreen - Whether to freeze player input during playback

Example:

boolean success = PixelPlayAPI.startVideo("https://youtube.com/watch?v=...", true);

startVideoWithEase(String url, boolean freezeScreen, EaseColor easeColor, double introSeconds, double outroSeconds)

Starts a video with fade-in and fade-out effects.

Parameters:

• url - Video URL
• freezeScreen - Whether to freeze player input
• easeColor - Color of fade effect (WHITE or BLACK)
• introSeconds - Fade-in duration in seconds
• outroSeconds - Fade-out duration in seconds

Example:

boolean success = PixelPlayAPI.startVideoWithEase(
    "https://example.com/video.mp4",
    false,
    VideoSession.EaseColor.BLACK,
    2.0,  
    3.0   
);

stopVideo()

Stops the currently playing video.

Example:

PixelPlayAPI.stopVideo();

isVideoPlaying()

Checks if a video is currently playing.

Example:

if (PixelPlayAPI.isVideoPlaying()) {
    
}

Audio Playback

startAudio(String url)

Starts simple audio playback.

Parameters:

• url Example:

PixelPlayAPI.startAudio("https://javivi.dev/music.mp3");

startAudioWithEase(String url, double introSeconds, double outroSeconds)

Starts audio with fade effects.

Parameters:

• url
• introSeconds
• outroSeconds Example:

PixelPlayAPI.startAudioWithEase("https://javivi.dev/music.mp3", 1.0, 2.0);

stopAudio()

Stops the currently playing audio. Example:

PixelPlayAPI.stopAudio();

Ease Effects

startEase(EaseColor easeColor, double introSeconds, double totalSeconds, double outroSeconds)

Starts a screen fade effect.

Parameters:

• easeColor - Color of the fade (WHITE or BLACK)
• introSeconds - Fade-in duration
• totalSeconds - Total effect duration
• outroSeconds - Fade-out duration

Returns: boolean - true if successful

Example:

PixelPlayAPI.startEase(VideoSession.EaseColor.WHITE, 1.0, 5.0, 1.0);

Utility Methods

getVolumeMultiplier()

Gets the current volume multiplier. Example:

float volume = PixelPlayAPI.getVolumeMultiplier();

setVolumeMultiplier(float multiplier)

Sets the volume multiplier.

Parameters:

• multiplier - Volume multiplier (0.0 to 1.0)

Example:

PixelPlayAPI.setVolumeMultiplier(0.5f); // 50% volume

isReady()

Checks if the API is ready to use.

Example:

if (PixelPlayAPI.isReady()) {
}

Inspired of VideoPlayer 🩵