YY-EVA Android

To use YY-EVA in your Android project, add the JitPack repository to your allprojects block and then add the dependency to your dependencies block.

For the stable version:

implementation 'com.github.yylive.YYEVA-Android:yyeva:1.0.17'

For the 2.0.0-beta version:

implementation 'com.github.yylive.YYEVA-Android:yyeva:2.0.0-beta'

allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}

dependencies {
	implementation 'com.github.yylive.YYEVA-Android:yyeva:1.0.17'
}

To use YYEVA-Android in your project, add the JitPack repository to your allprojects block in build.gradle, then add the dependency for the version you wish to use.

Note: Version 2.0.0-beta introduces changes in how playback is configured (using OptionParams).

// 1. Add JitPack to repositories
allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}

// 2. Add dependency
// For stable version:
dependencies {
	implementation 'com.github.yylive.YYEVA-Android:yyeva:1.0.17'
}

// For 2.0.0-beta version:
dependencies {
    implementation 'com.github.yylive.YYEVA-Android:yyeva:2.0.0-beta'
}

YY-EVA uses a hierarchical data structure to represent animation frames and sets of frames. This hierarchy allows for organized access to frame data, including source IDs, Z-order, and coordinate rectangles for rendering and output.

• EvaFrame: Represents a single animation frame. It contains:

  • srcId: The source effect ID.
  • z: The Z-order index.
  • frame: A PointRect representing the render frame.
  • mFrame: A PointRect representing the output frame.
  • mt: Mask rotation angle (v2 only supports 0 or 90 degrees).

• EvaFrameSet: A collection of EvaFrame objects belonging to a specific animation index (index).

• EvaFrameAll: A complete collection of all frames, organized as a SparseArray<EvaFrameSet> where the key is the frame set's index.

In version 2.0.0-beta, you can use the OptionParams class to configure various playback settings:

• frameRate: Set the animation frame rate (default: 30).
• playCount: Number of times to play.
• isMute: Whether the audio is muted.
• isRemoteService: Whether to use a multi-process mode.
• mp4Address: Path to the MP4 resource.
• scaleType: Scaling behavior (1: Crop center, 2: Full screen stretch, 3: Original size).
• filterType: High-definition algorithm (e.g., hermite or lagrange).

class OptionParams {
    var frameRate = 30
    var playCount = 1
    var isMute = false
    var isRemoteService = true
    var mp4Address = ""
    var scaleType = 1
    var filterType = ""
}

The IEvaAnimView interface is the primary way to control animation playback. Depending on your requirements, you can use EvaAnimView (for SurfaceView) or EvaAnimViewV3 (for TextureView).

interface IEvaAnimView {
    // Play from a File
    fun startPlay(file: File)

    // Play from Assets
    fun startPlay(assetManager: AssetManager, assetsPath: String)

    // Stop playback
    fun stopPlay()

    // Check if currently running
    fun isRunning(): Boolean

    // Set loop count
    fun setLoop(playLoop: Int)

    // Set background image
    fun setBgImage(bg: Bitmap)
}

If you need to provide custom images or text to the animation engine, implement the IEvaFetchResource interface. This allows the engine to fetch assets asynchronously:

• setImage(resource: EvaResource, result: (Bitmap?) -> Unit): Fetches an image. Note: Bitmap.Config.ALPHA_8 is currently not supported due to OpenGL compatibility issues on some devices.
• setText(resource: EvaResource, result: (String?) -> Unit): Fetches text content.
• releaseSrc(resources: List<EvaResource>): Notifies the engine that specific resources can be released.

interface IEvaFetchResource {
    fun setImage(resource: EvaResource, result:(Bitmap?) -> Unit)
    fun setText(resource: EvaResource, result:(String?) -> Unit)
    fun releaseSrc(resources: List<EvaResource>)
}

In version 2.0.0-beta, use the OptionParams class to configure playback behavior instead of direct interface calls. This includes settings for frame rate, mute status, scaling, and high-definition filters.

class OptionParams {
    var frameRate = 30
    var playCount = 1
    var isMute = false
    var isRemoteService = true  // Use multi-process
    var mp4Address = ""
    var scaleType = 1   // 1 => Crop center, 2 => Full screen stretch, 3 => Original size
    var filterType = "" // High-definition algorithms: "hermite" or "lagrange"
}

The EvaAnimConfig class is used to parse and manage the configuration for animation playback, typically loaded from a JSON file (often referred to as effectmp4json). It defines the video dimensions, RGB and Alpha frame positions, dynamic element (effect) properties, and per-frame positioning data.

To use it, create an instance of EvaAnimConfig and call the parse(json: JSONObject) method. If parsing succeeds, the object will be populated with the video's metadata, effects, and frame data. If parsing fails, the object will fall back to default configurations.

val config = EvaAnimConfig()
val success = config.parse(jsonConfigObject)
if (success) {
    // Use config.width, config.height, config.effects, etc.
}