diff --git a/multimedia/audio_framework/audio_capturer/native_audiocapturer.h b/multimedia/audio_framework/audio_capturer/native_audiocapturer.h index c2c3216f6243bc8de01335854d92fa1810e8b932..e6156afbdd42b7fadd7996770c7fb0ef1793b69c 100644 --- a/multimedia/audio_framework/audio_capturer/native_audiocapturer.h +++ b/multimedia/audio_framework/audio_capturer/native_audiocapturer.h @@ -45,7 +45,7 @@ #ifdef __cplusplus extern "C" { #endif -/* +/** * Request to release the capturer stream. * * @since 10 @@ -59,7 +59,7 @@ extern "C" { */ OH_AudioStream_Result OH_AudioCapturer_Release(OH_AudioCapturer* capturer); -/* +/** * Request to start the capturer stream. * * @since 10 @@ -73,7 +73,7 @@ OH_AudioStream_Result OH_AudioCapturer_Release(OH_AudioCapturer* capturer); */ OH_AudioStream_Result OH_AudioCapturer_Start(OH_AudioCapturer* capturer); -/* +/** * Request to pause the capturer stream. * * @since 10 @@ -87,7 +87,7 @@ OH_AudioStream_Result OH_AudioCapturer_Start(OH_AudioCapturer* capturer); */ OH_AudioStream_Result OH_AudioCapturer_Pause(OH_AudioCapturer* capturer); -/* +/** * Request to stop the capturer stream. * * @since 10 @@ -101,7 +101,7 @@ OH_AudioStream_Result OH_AudioCapturer_Pause(OH_AudioCapturer* capturer); */ OH_AudioStream_Result OH_AudioCapturer_Stop(OH_AudioCapturer* capturer); -/* +/** * Request to flush the capturer stream. * * @since 10 @@ -114,7 +114,7 @@ OH_AudioStream_Result OH_AudioCapturer_Stop(OH_AudioCapturer* capturer); */ OH_AudioStream_Result OH_AudioCapturer_Flush(OH_AudioCapturer* capturer); -/* +/** * Query the current state of the capturer client. * * This function will return the capturer state without updating the state. @@ -129,7 +129,7 @@ OH_AudioStream_Result OH_AudioCapturer_Flush(OH_AudioCapturer* capturer); */ OH_AudioStream_Result OH_AudioCapturer_GetCurrentState(OH_AudioCapturer* capturer, OH_AudioStream_State* state); -/* +/** * Query the latency mode of the capturer client. * * @since 10 @@ -143,20 +143,20 @@ OH_AudioStream_Result OH_AudioCapturer_GetCurrentState(OH_AudioCapturer* capture OH_AudioStream_Result OH_AudioCapturer_GetLatencyMode(OH_AudioCapturer* capturer, OH_AudioStream_LatencyMode* latencyMode); -/* +/** * Query the stream id of the capturer client. * * @since 10 * * @param capturer Reference created by OH_AudioStreamBuilder_GenerateCapturer() - * @param stramId Pointer to a variable that will be set for the stream id. + * @param streamId Pointer to a variable that will be set for the stream id. * @return Function result code: * {@link AUDIOSTREAM_SUCCESS} If the execution is successful. * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} The param of capturer is nullptr. */ OH_AudioStream_Result OH_AudioCapturer_GetStreamId(OH_AudioCapturer* capturer, uint32_t* streamId); -/* +/** * Query the sample rate value of the capturer client. * * This function will return the capturer sample rate value without updating the state. @@ -171,7 +171,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetStreamId(OH_AudioCapturer* capturer, u */ OH_AudioStream_Result OH_AudioCapturer_GetSamplingRate(OH_AudioCapturer* capturer, int32_t* rate); -/* +/** * Query the channel count of the capturer client. * * @since 10 @@ -184,7 +184,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetSamplingRate(OH_AudioCapturer* capture */ OH_AudioStream_Result OH_AudioCapturer_GetChannelCount(OH_AudioCapturer* capturer, int32_t* channelCount); -/* +/** * Query the sample format of the capturer client. * * @since 10 @@ -198,7 +198,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetChannelCount(OH_AudioCapturer* capture OH_AudioStream_Result OH_AudioCapturer_GetSampleFormat(OH_AudioCapturer* capturer, OH_AudioStream_SampleFormat* sampleFormat); -/* +/** * Query the encoding type of the capturer client. * * @since 10 @@ -212,7 +212,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetSampleFormat(OH_AudioCapturer* capture OH_AudioStream_Result OH_AudioCapturer_GetEncodingType(OH_AudioCapturer* capturer, OH_AudioStream_EncodingType* encodingType); -/* +/** * Query the capturer info of the capturer client. * * @since 10 @@ -226,7 +226,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetEncodingType(OH_AudioCapturer* capture OH_AudioStream_Result OH_AudioCapturer_GetCapturerInfo(OH_AudioCapturer* capturer, OH_AudioStream_SourceType* sourceType); -/* +/** * Query the frame size in callback, it is a fixed length of the buffer returned by each callback. * * @since 10 @@ -240,7 +240,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetCapturerInfo(OH_AudioCapturer* capture */ OH_AudioStream_Result OH_AudioCapturer_GetFrameSizeInCallback(OH_AudioCapturer* capturer, int32_t* frameSize); -/* +/** * Query the the time at which a particular frame was presented * * @since 10 @@ -259,7 +259,7 @@ OH_AudioStream_Result OH_AudioCapturer_GetFrameSizeInCallback(OH_AudioCapturer* OH_AudioStream_Result OH_AudioCapturer_GetTimestamp(OH_AudioCapturer* capturer, clockid_t clockId, int64_t* framePosition, int64_t* timestamp); -/* +/** * Query the the number of frames that have been read since the stream was created. * * @since 10 diff --git a/multimedia/audio_framework/audio_renderer/native_audiorenderer.h b/multimedia/audio_framework/audio_renderer/native_audiorenderer.h index 6bfcb82ae0aafb754cfa5abf49fe928a33e9c2da..54de15bed001c5bdaec9b9811cada9b62bb4ac53 100644 --- a/multimedia/audio_framework/audio_renderer/native_audiorenderer.h +++ b/multimedia/audio_framework/audio_renderer/native_audiorenderer.h @@ -48,7 +48,7 @@ #ifdef __cplusplus extern "C" { #endif -/* +/** * Request to release the renderer stream. * * @since 10 @@ -61,7 +61,7 @@ extern "C" { */ OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer* renderer); -/* +/** * Request to start the renderer stream. * * @since 10 @@ -74,7 +74,7 @@ OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer* renderer); */ OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer* renderer); -/* +/** * Request to pause the renderer stream. * * @since 10 @@ -87,7 +87,7 @@ OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer* renderer); */ OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer* renderer); -/* +/** * Request to stop renderer stream. * * @since 10 @@ -100,7 +100,7 @@ OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer* renderer); */ OH_AudioStream_Result OH_AudioRenderer_Stop(OH_AudioRenderer* renderer); -/* +/** * Request to flush the renderer stream. * * @since 10 @@ -113,7 +113,7 @@ OH_AudioStream_Result OH_AudioRenderer_Stop(OH_AudioRenderer* renderer); */ OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer* renderer); -/* +/** * Query the current state of the renderer client. * * This function will return the renderer state without updating the state. @@ -129,7 +129,7 @@ OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer* renderer); OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer* renderer, OH_AudioStream_State* state); -/* +/** * Query the sample rate value of the renderer client * * This function will return the renderer sample rate value without updating the state. @@ -144,20 +144,20 @@ OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer* rendere */ OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer* renderer, int32_t* rate); -/* +/** * Query the stream id of the renderer client. * * @since 10 * * @param renderer Reference created by OH_AudioStreamBuilder_GenerateRenderer() - * @param stramId Pointer to a variable that will be set for the stream id. + * @param streamId Pointer to a variable that will be set for the stream id. * @return Function result code: * {@link AUDIOSTREAM_SUCCESS} If the execution is successful. * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} The param of renderer is nullptr. */ OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer* renderer, uint32_t* streamId); -/* +/** * Query the channel count of the renderer client. * * @since 10 @@ -170,7 +170,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer* renderer, u */ OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer* renderer, int32_t* channelCount); -/* +/** * Query the sample format of the renderer client. * * @since 10 @@ -184,7 +184,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer* rendere OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer* renderer, OH_AudioStream_SampleFormat* sampleFormat); -/* +/** * Query the latency mode of the renderer client. * * @since 10 @@ -197,7 +197,8 @@ OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer* rendere */ OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer* renderer, OH_AudioStream_LatencyMode* latencyMode); -/* + +/** * Query the renderer info of the renderer client. * * The rendere info includes {@link OH_AudioStream_Usage} value. @@ -213,7 +214,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer* renderer OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer* renderer, OH_AudioStream_Usage* usage); -/* +/** * Query the encoding type of the renderer client. * * @since 10 @@ -227,7 +228,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer* rendere OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer* renderer, OH_AudioStream_EncodingType* encodingType); -/* +/** * Query the the number of frames that have been written since the stream was created. * * @since 10 @@ -240,7 +241,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer* rendere */ OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer* renderer, int64_t* frames); -/* +/** * Query the the time at which a particular frame was presented. * * @since 10 @@ -259,7 +260,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer* render OH_AudioStream_Result OH_AudioRenderer_GetTimestamp(OH_AudioRenderer* renderer, clockid_t clockId, int64_t* framePosition, int64_t* timestamp); -/* +/** * Query the frame size in callback, it is a fixed length that the stream want to be filled for each callback. * * @since 10 @@ -272,7 +273,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetTimestamp(OH_AudioRenderer* renderer, */ OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer* renderer, int32_t* frameSize); -/* +/** * Query the playback speed of the stream client * * @since 11 @@ -286,7 +287,7 @@ OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer* OH_AudioStream_Result OH_AudioRenderer_GetSpeed(OH_AudioRenderer* renderer, float* speed); -/* +/** * Set the playback speed of the stream client * * @since 11 diff --git a/multimedia/audio_framework/common/native_audiostreambuilder.h b/multimedia/audio_framework/common/native_audiostreambuilder.h index de4451adfa7915fd37f208216aaa7c85105cdbbd..fcf011343f67d0da836d0fc8b1672c0e28609f85 100644 --- a/multimedia/audio_framework/common/native_audiostreambuilder.h +++ b/multimedia/audio_framework/common/native_audiostreambuilder.h @@ -75,13 +75,13 @@ OH_AudioStream_Result OH_AudioStreamBuilder_Create(OH_AudioStreamBuilder** build */ OH_AudioStream_Result OH_AudioStreamBuilder_Destroy(OH_AudioStreamBuilder* builder); -/* +/** * Set the channel count of the capturer client * * @since 10 * - * @param capturer Reference created by OH_AudioStreamBuilder - * @param channelCount Pointer to a variable that will be set for the channel count. + * @param builder Reference created by OH_AudioStreamBuilder + * @param rate Pointer to a variable that will be set for the channel count. * @return Function result code: * {@link AUDIOSTREAM_SUCCESS} If the execution is successful. * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}: @@ -90,7 +90,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_Destroy(OH_AudioStreamBuilder* build */ OH_AudioStream_Result OH_AudioStreamBuilder_SetSamplingRate(OH_AudioStreamBuilder* builder, int32_t rate); -/* +/** * Set the channel count of the stream client * * @since 10 @@ -105,7 +105,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetSamplingRate(OH_AudioStreamBuilde */ OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelCount(OH_AudioStreamBuilder* builder, int32_t channelCount); -/* +/** * Set the sample format of the stream client * * @since 10 @@ -119,7 +119,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelCount(OH_AudioStreamBuilde OH_AudioStream_Result OH_AudioStreamBuilder_SetSampleFormat(OH_AudioStreamBuilder* builder, OH_AudioStream_SampleFormat format); -/* +/** * Set the encoding type of the stream client * * @since 10 @@ -133,7 +133,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetSampleFormat(OH_AudioStreamBuilde OH_AudioStream_Result OH_AudioStreamBuilder_SetEncodingType(OH_AudioStreamBuilder* builder, OH_AudioStream_EncodingType encodingType); -/* +/** * Set the latency mode of the stream client * * @since 10 @@ -161,7 +161,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetLatencyMode(OH_AudioStreamBuilder OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelLayout(OH_AudioStreamBuilder* builder, OH_AudioChannelLayout channelLayout); -/* +/** * Set the renderer information of the stream client * * @since 10 @@ -177,7 +177,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetChannelLayout(OH_AudioStreamBuild OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInfo(OH_AudioStreamBuilder* builder, OH_AudioStream_Usage usage); -/* +/** * Set the capturer information of the stream client * * @since 10 @@ -193,7 +193,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInfo(OH_AudioStreamBuilde OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerInfo(OH_AudioStreamBuilder* builder, OH_AudioStream_SourceType sourceType); -/* +/** * Set the callbacks for the renderer client * * @since 10 @@ -243,7 +243,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererOutputDeviceChangeCallbac OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererPrivacy(OH_AudioStreamBuilder* builder, OH_AudioStream_PrivacyType privacy); -/* +/** * Set the callbacks for the capturer client * * @since 10 @@ -260,7 +260,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererPrivacy(OH_AudioStreamBui OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerCallback(OH_AudioStreamBuilder* builder, OH_AudioCapturer_Callbacks callbacks, void* userData); -/* +/** * Create the audio renderer client. * * @since 10 @@ -277,7 +277,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetCapturerCallback(OH_AudioStreamBu OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer(OH_AudioStreamBuilder* builder, OH_AudioRenderer** audioRenderer); -/* +/** * Create the audio capturer client. * * @since 10 @@ -294,7 +294,7 @@ OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer(OH_AudioStreamBuild OH_AudioStream_Result OH_AudioStreamBuilder_GenerateCapturer(OH_AudioStreamBuilder* builder, OH_AudioCapturer** audioCapturer); -/* +/** * Set the data frame size for each callback, use this function if the application requires a specific number * of frames for processing. * The frame size should be at least the size device process at one time, and less than half the internal