lingxia-platform 0.7.0

Platform abstraction layer for LingXia framework (Android, iOS, HarmonyOS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use std::path::{Path, PathBuf};

use crate::error::PlatformError;

use super::media_interaction::MediaKind;

#[derive(Debug, Clone)]
pub struct ImageInfo {
    pub width: u32,
    pub height: u32,
    pub mime_type: Option<String>,
}

#[derive(Debug, Clone)]
pub struct CompressImageRequest {
    pub source_uri: String,
    pub quality: u8,
    pub max_width: Option<u32>,
    pub max_height: Option<u32>,
    pub output_path: PathBuf,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum VideoCompressQuality {
    Low,
    Medium,
    High,
}

#[derive(Debug, Clone)]
pub struct CompressVideoRequest {
    pub source_uri: String,
    pub quality: Option<VideoCompressQuality>,
    /// Target average bitrate in kbps.
    pub bitrate_kbps: Option<u32>,
    /// Target frame rate in fps.
    pub fps: Option<u32>,
    /// Scale ratio relative to source resolution in (0, 1].
    pub resolution_ratio: Option<f32>,
    pub output_path: PathBuf,
}

#[derive(Debug, Clone)]
pub struct CompressedVideo {
    pub path: PathBuf,
    pub width: u32,
    pub height: u32,
    pub duration_ms: u64,
    pub size: u64,
    pub mime_type: Option<String>,
}

#[derive(Debug, Clone)]
pub struct VideoInfo {
    pub width: u32,
    pub height: u32,
    pub duration_ms: u64,
    pub rotation: Option<u16>,
    pub bitrate: Option<u64>,
    pub fps: Option<f32>,
    pub mime_type: Option<String>,
}

#[derive(Debug, Clone)]
pub struct ExtractVideoThumbnailRequest {
    pub source_uri: String,
    pub output_path: PathBuf,
    pub max_width: Option<u32>,
    pub max_height: Option<u32>,
    pub time_ms: Option<u64>,
    pub quality: u8,
}

#[derive(Debug, Clone)]
pub struct VideoThumbnail {
    pub path: PathBuf,
    pub width: u32,
    pub height: u32,
    pub mime_type: Option<String>,
}

pub trait MediaRuntime: Send + Sync + 'static {
    /// Copy a picked/album media asset identified by `uri` into a local file at `dest_path`.
    ///
    /// Notes:
    /// - `uri` is an opaque platform media reference coming from platform pickers and may not be a
    ///   directly readable filesystem path.
    /// - Implementations should support platform-specific schemes as applicable, for example:
    ///   - Android: `content://...`
    ///   - iOS: `ph://...` (or other Photos identifiers)
    ///   - Harmony: picker URIs such as `file://media/...`
    ///   - Some platforms may also provide `file:///absolute/path` (or an absolute path string).
    /// - Implementations should create parent directories for `dest_path` if needed and write the
    ///   file content so that `dest_path` exists on success.
    fn copy_album_media_to_file(
        &self,
        uri: &str,
        dest_path: &Path,
        kind: MediaKind,
    ) -> Result<(), PlatformError>;

    fn get_image_info(&self, uri: &str) -> Result<ImageInfo, PlatformError>;

    fn compress_image(&self, request: &CompressImageRequest) -> Result<PathBuf, PlatformError>;

    fn compress_video(
        &self,
        request: &CompressVideoRequest,
    ) -> Result<CompressedVideo, PlatformError>;

    fn get_video_info(&self, uri: &str) -> Result<VideoInfo, PlatformError>;

    fn extract_video_thumbnail(
        &self,
        request: &ExtractVideoThumbnailRequest,
    ) -> Result<VideoThumbnail, PlatformError>;
}