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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

// 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::avformat::OH_AVFormat;
use ohos_sys_opaque_types::OH_PixelmapNative;

/// Define OH_AVMetadataExtractor field.
///
///
/// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
///
/// Available since API-level: 18
#[cfg(feature = "api-18")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
#[repr(C)]
pub struct OH_AVMetadataExtractor {
    _unused: [u8; 0],
}
extern "C" {
    /// Create a metadata extractor.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
    ///
    /// # Returns
    ///
    /// * Returns a pointer to an OH_AVMetadataExtractor instance for success, nullptr for failure
    /// Possible failure causes: failed to HstEngineFactory::CreateAVMetadataHelperEngine.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_AVMetadataExtractor_Create() -> *mut OH_AVMetadataExtractor;
    /// Sets the media file descriptor source for the metadata extractor.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
    /// # Arguments
    ///
    /// * `extractor` - Pointer to an OH_AVMetadataExtractor 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 extractor 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_AVMetadataExtractor_SetFDSource(
        extractor: *mut OH_AVMetadataExtractor,
        fd: i32,
        offset: i64,
        size: i64,
    ) -> OH_AVErrCode;
    /// Extract metadata info from the media source.
    /// This function must be called after [`SetFDSource`].
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
    /// # Arguments
    ///
    /// * `extractor` - Pointer to an OH_AVMetadataExtractor instance.
    ///
    /// * `avMetadata` - Pointer to an [`OH_AVFormat`] instance, its content contains the fetched metadata info.
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input extractor 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_AVMetadataExtractor_FetchMetadata(
        extractor: *mut OH_AVMetadataExtractor,
        avMetadata: *mut OH_AVFormat,
    ) -> OH_AVErrCode;
    /// Fetch album cover from the audio source.
    /// This function must be called after [`SetFDSource`].
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
    /// # Arguments
    ///
    /// * `extractor` - Pointer to an OH_AVMetadataExtractor instance.
    ///
    /// * `pixelMap` - The fetched album cover from the audio source. For details, see [`OH_PixelmapNative`].
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input extractor 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_AVMetadataExtractor_FetchAlbumCover(
        extractor: *mut OH_AVMetadataExtractor,
        pixelMap: *mut *mut OH_PixelmapNative,
    ) -> OH_AVErrCode;
    /// Release the resource used for AVMetadataExtractor.
    ///
    ///
    /// Required System Capabilities: SystemCapability.Multimedia.Media.AVMetadataExtractor
    /// # Arguments
    ///
    /// * `extractor` - Pointer to an OH_AVMetadataExtractor instance.
    ///
    /// # Returns
    ///
    /// * Function result code.
    /// [`AV_ERR_OK`] if the execution is successful.
    /// [`AV_ERR_INVALID_VAL`] if input extractor 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_AVMetadataExtractor_Release(extractor: *mut OH_AVMetadataExtractor) -> OH_AVErrCode;
}