ohos-media-sys 0.1.0

Raw Bindings to the media framework on OpenHarmony
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
118
119
120
121
122
123
124

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(deprecated)]
#[allow(unused_imports)]
use crate::averrors::OH_AVErrCode;
#[allow(unused_imports)]
use crate::avimage_generator_base::OH_AVImageGenerator_QueryOptions;
use ohos_sys_opaque_types::OH_PixelmapNative;

/// Define OH_AVImageGenerator field.
///
///
/// Required System Capabilities: SystemCapability.Multimedia.Media.AVImageGenerator
///
/// Available since API-level: 18
#[cfg(feature = "api-18")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
#[repr(C)]
pub struct OH_AVImageGenerator {
    _unused: [u8; 0],
}
extern "C" {
    /// Create an image generator.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVImageGenerator
    ///
    /// # Returns
    ///
    /// * Returns a pointer to an OH_AVImageGenerator instance for success, nullptr for failure.
    /// Possible failure causes: HstEngineFactory failed to CreateAVMetadataHelperEngine.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_AVImageGenerator_Create() -> *mut OH_AVImageGenerator;
    /// Sets the media file descriptor source for the image generator.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVImageGenerator
    /// # Arguments
    ///
    /// * `generator` - Pointer to an OH_AVImageGenerator instance.
    ///
    /// * `fd` - Indicates the file descriptor of media source.
    ///
    /// * `offset` - Indicates the offset of media source in file descriptor.
    ///
    /// * `size` - Indicates the size of media source.
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input generator is nullptr or input param is invalid.
    /// [`AV_ERR_OPERATE_NOT_PERMIT`] if operation not allowed.
    /// [`AV_ERR_NO_MEMORY`] if internal memory allocation failed.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_AVImageGenerator_SetFDSource(
        generator: *mut OH_AVImageGenerator,
        fd: i32,
        offset: i64,
        size: i64,
    ) -> OH_AVErrCode;
    /// Fetch an image at the specific time from a video resource.
    ///
    /// This function must be called after [`SetFDSource`].
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVImageGenerator
    /// # Arguments
    ///
    /// * `generator` - Pointer to an OH_AVImageGenerator instance.
    ///
    /// * `timeUs` - The time expected to fetch picture from the video resource. The unit is microsecond(us).
    ///
    /// * `options` - The time options about the relationship between the given timeUs and a key frame,
    /// see [`OH_AVImageGenerator_QueryOptions`].
    ///
    /// * `pixelMap` - The fetched output image from the video source. For details, see [`OH_PixelmapNative`].
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input generator is nullptr or input param is invalid.
    /// [`AV_ERR_OPERATE_NOT_PERMIT`] if operation not allowed.
    /// [`AV_ERR_UNSUPPORTED_FORMAT`] if format is unsupported.
    /// [`AV_ERR_NO_MEMORY`] if internal memory allocation failed.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_AVImageGenerator_FetchFrameByTime(
        generator: *mut OH_AVImageGenerator,
        timeUs: i64,
        options: OH_AVImageGenerator_QueryOptions,
        pixelMap: *mut *mut OH_PixelmapNative,
    ) -> OH_AVErrCode;
    /// Release the resource used for AVImageGenerator.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVImageGenerator
    /// # Arguments
    ///
    /// * `generator` - Pointer to an OH_AVImageGenerator instance.
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input generator is nullptr or input param is invalid.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_AVImageGenerator_Release(generator: *mut OH_AVImageGenerator) -> OH_AVErrCode;
}