ohaudio-sys 0.1.0

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#[cfg(feature = "api-20")]
use crate::audio_device_base::OH_AudioDeviceDescriptorArray;
use crate::audiostream_base::*;
use libc::clockid_t;

/// Called when audio data is available to read. This function is similar to
/// OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnReadData.
///
/// # Arguments
///
/// * `capturer` - Pointer to the AudioCapturer instance that triggers the callback.
///
/// * `userData` - Pointer to the user data passed when setting the callback via
/// OH_AudioStreamBuilder_SetCapturerReadDataCallback.
///
/// * `audioData` - Pointer to the available audio data.
///
/// * `audioDataSize` - Size of the available audio data.
/// [`OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnReadData`]
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioCapturer_OnReadDataCallback = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        audioData: *mut ::core::ffi::c_void,
        audioDataSize: i32,
    ),
>;
/// Called when the input device of an AudioCapturer instance changes.
/// This function is similar to OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnStreamEvent.
///
/// # Arguments
///
/// * `capturer` - Pointer to the AudioCapturer instance that triggers the callback.
///
/// * `userData` - Pointer to the user data passed when setting the callback via
/// OH_AudioStreamBuilder_SetCapturerDeviceChangeCallback.
///
/// * `deviceArray` - Pointer to an array of the new input devices.
/// [`OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnStreamEvent`]
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioCapturer_OnDeviceChangeCallback = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        deviceArray: *mut OH_AudioDeviceDescriptorArray,
    ),
>;
/// Called when an interrupt event occurs in an AudioCapturer instance.
/// This function is similar to OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnInterruptEvent.
///
/// # Arguments
///
/// * `capturer` - Pointer to the AudioCapturer instance that triggers the callback.
///
/// * `userData` - Pointer to the user data passed when setting the callback via
/// OH_AudioStreamBuilder_SetCapturerInterruptCallback.
///
/// * `type` - Type of force that causes the interrupt event.
///
/// * `hint` - Hint provided along with the interrupt event.
/// [`OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnInterruptEvent.`]
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioCapturer_OnInterruptCallback = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        type_: OH_AudioInterrupt_ForceType,
        hint: OH_AudioInterrupt_Hint,
    ),
>;
/// Called when an error event occurs in an AudioCapturer instance.
/// This function is similar to OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnError.
///
/// # Arguments
///
/// * `capturer` - Pointer to the AudioCapturer instance that triggers the callback.
///
/// * `userData` - Pointer to the user data passed when setting the callback via
/// OH_AudioStreamBuilder_SetCapturerErrorCallback.
///
/// * `error` - Specific error information.
/// [`OH_AudioCapturer_Callbacks_Struct.OH_AudioCapturer_OnError`]
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioCapturer_OnErrorCallback = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        error: OH_AudioStream_Result,
    ),
>;
/// Callback function of fast status change event for audio capturer.
///
/// # Arguments
///
/// * `capturer` - Pointer to an audio capturer instance for which this callback occurs.
///
/// * `userData` - Userdata which is passed by register.
///
/// * `status` - Current fast status.
///
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioCapturer_OnFastStatusChange = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        status: OH_AudioStream_FastStatus,
    ),
>;
/// Callback function to get playback capture start result.
///
/// # Arguments
///
/// * `capturer` - Pointer to the AudioCapturer instance that triggers the callback.
///
/// * `userData` - Pointer to the user data passed when setting the callback via
/// [`#OH_AudioCapturer_RequestPlaybackCaptureStart`].
///
/// * `state` - The final state to describe whether start request is successful.
///
/// Available since API-level: 23
#[cfg(feature = "api-23")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-23")))]
pub type OH_AudioCapturer_OnPlaybackCaptureStartCallback = ::core::option::Option<
    unsafe extern "C" fn(
        capturer: *mut OH_AudioCapturer,
        userData: *mut ::core::ffi::c_void,
        state: OH_AudioStream_PlaybackCaptureStartState,
    ),
>;
extern "C" {
    /// Request to release the capturer stream.
    ///
    ///
    /// Available since API-level: 10
    /// ohos.permission.MICROPHONE
    ///
    /// # Arguments
    ///
    /// * `capturer` - reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_Release(capturer: *mut OH_AudioCapturer) -> OH_AudioStream_Result;
    /// Request to start the capturer stream.
    ///
    ///
    /// Available since API-level: 10
    /// ohos.permission.MICROPHONE
    ///
    /// # Arguments
    ///
    /// * `capturer` - reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_Start(capturer: *mut OH_AudioCapturer) -> OH_AudioStream_Result;
    /// Request to pause the capturer stream.
    ///
    ///
    /// Available since API-level: 10
    /// ohos.permission.MICROPHONE
    ///
    /// # Arguments
    ///
    /// * `capturer` - reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_Pause(capturer: *mut OH_AudioCapturer) -> OH_AudioStream_Result;
    /// Request to stop the capturer stream.
    ///
    ///
    /// Available since API-level: 10
    /// ohos.permission.MICROPHONE
    ///
    /// # Arguments
    ///
    /// * `capturer` - reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_Stop(capturer: *mut OH_AudioCapturer) -> OH_AudioStream_Result;
    /// Request to flush the capturer stream.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_Flush(capturer: *mut OH_AudioCapturer) -> OH_AudioStream_Result;
    /// Query the current state of the capturer client.
    ///
    /// This function will return the capturer state without updating the state.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `state` - Pointer to a variable that will be set for the state value.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetCurrentState(
        capturer: *mut OH_AudioCapturer,
        state: *mut OH_AudioStream_State,
    ) -> OH_AudioStream_Result;
    /// Query the latency mode of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `latencyMode` - Pointer to a variable that will be set for the latency mode.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetLatencyMode(
        capturer: *mut OH_AudioCapturer,
        latencyMode: *mut OH_AudioStream_LatencyMode,
    ) -> OH_AudioStream_Result;
    /// Query the stream id of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `streamId` - Pointer to a variable that will be set for the stream id.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetStreamId(
        capturer: *mut OH_AudioCapturer,
        streamId: *mut u32,
    ) -> OH_AudioStream_Result;
    /// Query the sample rate value of the capturer client.
    ///
    /// This function will return the capturer sample rate value without updating the state.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `rate` - The state value to be updated
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetSamplingRate(
        capturer: *mut OH_AudioCapturer,
        rate: *mut i32,
    ) -> OH_AudioStream_Result;
    /// Query the channel count of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `channelCount` - Pointer to a variable that will be set for the channel count.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetChannelCount(
        capturer: *mut OH_AudioCapturer,
        channelCount: *mut i32,
    ) -> OH_AudioStream_Result;
    /// Query the sample format of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `sampleFormat` - Pointer to a variable that will be set for the sample format.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetSampleFormat(
        capturer: *mut OH_AudioCapturer,
        sampleFormat: *mut OH_AudioStream_SampleFormat,
    ) -> OH_AudioStream_Result;
    /// Query the encoding type of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `encodingType` - Pointer to a variable that will be set for the encoding type.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetEncodingType(
        capturer: *mut OH_AudioCapturer,
        encodingType: *mut OH_AudioStream_EncodingType,
    ) -> OH_AudioStream_Result;
    /// Query the capturer info of the capturer client.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `sourceType` - Pointer to a variable that will be set for the stream sourceType.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetCapturerInfo(
        capturer: *mut OH_AudioCapturer,
        sourceType: *mut OH_AudioStream_SourceType,
    ) -> OH_AudioStream_Result;
    /// Query the frame size in callback, it is a fixed length of the buffer returned by each callback.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `frameSize` - Pointer to a variable that will be set for the frame size.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_GetFrameSizeInCallback(
        capturer: *mut OH_AudioCapturer,
        frameSize: *mut i32,
    ) -> OH_AudioStream_Result;
    /// Query the the time at which a particular frame was presented
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `clockId` - [`#CLOCK_MONOTONIC`]
    ///
    /// * `framePosition` - Pointer to a variable to receive the position
    ///
    /// * `timestamp` - Pointer to a variable to receive the timestamp
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`]:
    /// 1.The param of capturer is nullptr;
    /// 2.The param of clockId invalid.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Execution status exception.
    pub fn OH_AudioCapturer_GetTimestamp(
        capturer: *mut OH_AudioCapturer,
        clockId: clockid_t,
        framePosition: *mut i64,
        timestamp: *mut i64,
    ) -> OH_AudioStream_Result;
    /// Query the the number of frames that have been read since the stream was created.
    ///
    ///
    /// Available since API-level: 10
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `frames` - Pointer to a variable that will be set for the frame count number.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    pub fn OH_AudioCapturer_GetFramesRead(
        capturer: *mut OH_AudioCapturer,
        frames: *mut i64,
    ) -> OH_AudioStream_Result;
    /// Gets the overflow count on this stream.
    ///
    ///
    /// Available since API-level: 12
    ///
    /// # Arguments
    ///
    /// * `capturer` - Capturer generated by OH_AudioStreamBuilder_GenerateCapturer()
    ///
    /// * `count` - Pointer to a variable that will be set for the overflow count number.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr.
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_AudioCapturer_GetOverflowCount(
        capturer: *mut OH_AudioCapturer,
        count: *mut u32,
    ) -> OH_AudioStream_Result;
    /// Gets audio capturer running status, check if it works in fast status.
    ///
    /// # Arguments
    ///
    /// * `capturer` - Reference created by OH_AudioStreamBuilder_GenerateCapturer.
    ///
    /// * `status` - Pointer to a variable to receive the status.
    ///
    /// # Returns
    ///
    /// * [`AUDIOSTREAM_SUCCESS`] if the execution is successful.
    /// [`AUDIOSTREAM_ERROR_INVALID_PARAM`] the param of capturer is nullptr.
    /// [`AUDIOSTREAM_ERROR_ILLEGAL_STATE`] function called in invalid state, only available before release state.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_AudioCapturer_GetFastStatus(
        capturer: *mut OH_AudioCapturer,
        status: *mut OH_AudioStream_FastStatus,
    ) -> OH_AudioStream_Result;
    /// Asynchronously request to start the playback capture stream.
    /// This function is non-blocking, which means system will continue to process user authorization and
    /// stream starting when receiving the start request. And the final result will be returned by callback.
    /// # Arguments
    ///
    /// * `capturer` - reference created by [`#OH_AudioStreamBuilder_GenerateCapturer`]
    ///
    /// * `callback` - Callback function used to receive the final result of start request.
    ///
    /// * `userData` - Pointer to an application data structure that will be passed to the callback functions.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`#AUDIOSTREAM_SUCCESS`] If the execution is successful.
    /// [`#AUDIOSTREAM_ERROR_INVALID_PARAM`] The param of capturer is nullptr or callback is invalid.
    /// [`#AUDIOSTREAM_ERROR_ILLEGAL_STATE`] Running and released are illegal states.
    /// [`#AUDIOSTREAM_ERROR_SYSTEM`] System internal error, like audio service error.
    ///
    /// Available since API-level: 23
    #[cfg(feature = "api-23")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-23")))]
    pub fn OH_AudioCapturer_RequestPlaybackCaptureStart(
        capturer: *mut OH_AudioCapturer,
        callback: OH_AudioCapturer_OnPlaybackCaptureStartCallback,
        userData: *mut ::core::ffi::c_void,
    ) -> OH_AudioStream_Result;
}