diff --git a/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_routing_manager.h b/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_routing_manager.h index efdb5c78d65004ea6eb53f66a9819048849e5c75..1b5d44e7af1f635949dadc06d3b2119fc19214d6 100644 --- a/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_routing_manager.h +++ b/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_routing_manager.h @@ -72,6 +72,7 @@ typedef int32_t (*OH_AudioRoutingManager_OnDeviceChangedCallback) ( * * @param audioRoutingManager 音频路由管理器句柄。 {@link OH_AudioRoutingManager} * 获取句柄通过 {@link OH_AudioManager_GetAudioRoutingManager}。 + * 值为nullptr会导致崩溃。 * @return 函数返回值： * {@link AUDIOCOMMON_RESULT_SUCCESS} 函数执行成功。 * @since 12 @@ -93,7 +94,7 @@ OH_AudioCommon_Result OH_AudioManager_GetAudioRoutingManager(OH_AudioRoutingMana * 1. 参数audioRoutingManager为nullptr； * 2. 参数deviceFlag无效； * 3. 参数audioDeviceDescriptorArray为nullptr。 - * {@link AUDIOCOMMON_RESULT_ERROR_NO_MEMORY} 内存不足。 + * {@link AUDIOCOMMON_RESULT_ERROR_NO_MEMORY} 任何原因导致的未获取到设备描述符。 * @since 12 */ OH_AudioCommon_Result OH_AudioRoutingManager_GetDevices( @@ -256,13 +257,13 @@ OH_AudioCommon_Result OH_AudioRoutingManager_IsMicBlockDetectionSupported( * * @param audioRoutingManager 音频路由管理器句柄。 {@link OH_AudioRoutingManager} * 获取句柄通过{@link OH_AudioManager_GetAudioRoutingManager}。 - * @param callback 函数指针将指向用于返回接受设备麦克风堵塞状态 {@link OH_AudioRoutingManager_OnDeviceBlockStatusCallback} + * @param callback 函数指针将指向用于返回接受设备麦克风堵塞状态 {@link OH_AudioRoutingManager_OnDeviceBlockStatusCallback}。值为nullptr时用于取消回调。 * @param userData 用户自定义数据指针。 * @return 函数返回值： * {@link AUDIOCOMMON_RESULT_SUCCESS} 函数执行成功。 * {@link AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM}: * 1.参数audioRoutingManager为nullptr； - * 2.参数callback为nullptr。 + * 2.其它原因导致的执行失败。 * @since 13 */ OH_AudioCommon_Result OH_AudioRoutingManager_SetMicBlockStatusCallback( diff --git a/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_session_manager.h b/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_session_manager.h index fbe36bb3b6905329d4dbf063eb0fc0c014ad5976..63c77d4f2f5a4d37226dbfa036058f5f7644026b 100644 --- a/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_session_manager.h +++ b/zh-cn/native_sdk/multimedia/audio_framework/audio_manager/native_audio_session_manager.h @@ -137,7 +137,7 @@ typedef int32_t (*OH_AudioSession_DeactivatedCallback) ( * * 使用音频会话管理器相关功能，首先需要获取音频会话管理器实例。 * - * @param audioSessionManager 指向{@link OH_AudioSessionManager}音频会话管理器实例。 + * @param audioSessionManager 指向{@link OH_AudioSessionManager}音频会话管理器实例。值为nullptr会导致崩溃。 * * @return 函数返回值： * {@link AUDIOCOMMON_RESULT_SUCCESS} 函数执行成功。 @@ -155,7 +155,7 @@ OH_AudioCommon_Result OH_AudioManager_GetAudioSessionManager( * {@link AUDIOCOMMON_RESULT_SUCCESS} 函数执行成功。 * {@link AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM}： * 1. 参数audioSessionManager为nullptr； - * 2. 参数strategy无效。 + * 2. 参数strategy为nullptr。 * {@link AUDIOCOMMON_RESULT_ERROR_ILLEGAL_STATE} 非法状态。 * @since 12 */ diff --git a/zh-cn/native_sdk/multimedia/audio_framework/audio_renderer/native_audiorenderer.h b/zh-cn/native_sdk/multimedia/audio_framework/audio_renderer/native_audiorenderer.h index b56206ad6e0b18d774c64a4d5a4421bcf05a33ab..b2cd4259fea195126b022248563c10e5b6056f80 100644 --- a/zh-cn/native_sdk/multimedia/audio_framework/audio_renderer/native_audiorenderer.h +++ b/zh-cn/native_sdk/multimedia/audio_framework/audio_renderer/native_audiorenderer.h @@ -118,7 +118,9 @@ OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer* renderer); * @param state 指向一个用来接收音频流状态的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数state为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer* renderer, OH_AudioStream_State* state); @@ -132,7 +134,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer* rendere * @param rate 指向一个用来接收音频流采样率的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数rate为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer* renderer, int32_t* rate); @@ -145,7 +149,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer* rendere * @param streamId 指向一个用来接收音频流ID的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数streamId为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer* renderer, uint32_t* streamId); @@ -158,7 +164,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer* renderer, u * @param channelCount 指向一个用来接收音频流通道数的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数channelCount为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer* renderer, int32_t* channelCount); @@ -171,7 +179,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer* rendere * @param sampleFormat 指向一个用来接收音频流采样格式的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数sampleFormat为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer* renderer, OH_AudioStream_SampleFormat* sampleFormat); @@ -185,7 +195,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer* rendere * @param latencyMode 指向一个用来接收音频流时延模式的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数latencyMode为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer* renderer, OH_AudioStream_LatencyMode* latencyMode); @@ -201,7 +213,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer* renderer * @param usage 指向一个用来接收输出类型音频流的工作场景的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数usage为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer* renderer, OH_AudioStream_Usage* usage); @@ -215,7 +229,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer* rendere * @param encodingType 指向一个用来接收音频流编码类型的变量(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数encodingType为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer* renderer, OH_AudioStream_EncodingType* encodingType); @@ -229,7 +245,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer* rendere * @param frames 指向将为帧计数设置的变量的指针(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数frames为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer* renderer, int64_t* frames); @@ -251,7 +269,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer* render * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： * 1. 参数renderer为nullptr； - * 2. 参数clockId无效。 + * 2. 参数clockId无效； + * 3. 参数framePosition为nullptr； + * 4. 参数timestamp为nullptr。 * {@link AUDIOSTREAM_ERROR_ILLEGAL_STATE} 执行状态异常。 */ OH_AudioStream_Result OH_AudioRenderer_GetTimestamp(OH_AudioRenderer* renderer, clockid_t clockId, @@ -294,7 +314,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetAudioTimestampInfo(OH_AudioRenderer* r * @param frameSize 指向将为帧大小设置的变量的指针(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数frameSize为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer* renderer, int32_t* frameSize); @@ -307,7 +329,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer* * @param speed 指向接收播放倍速值的变量的指针(作为返回值使用)。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数speed为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetSpeed(OH_AudioRenderer* renderer, float* speed); @@ -317,7 +341,18 @@ OH_AudioStream_Result OH_AudioRenderer_GetSpeed(OH_AudioRenderer* renderer, floa * @since 11 * @syscap SystemCapability.Multimedia.Audio.Core * @param renderer 指向{@link OH_AudioStreamBuilder_GenerateRenderer}创建的音频流实例。 - * @param speed 设置播放的倍速值（倍速范围：0.25-4.0）。 + * @param speed 设置播放的倍速值（倍速范围：0.25-4.0），值不在有效范围内不生效。 + * @return 函数返回值： + * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + */ +/** + * @brief 设置音频渲染速率。 + * + * @since 12 + * @syscap SystemCapability.Multimedia.Audio.Core + * @param renderer 指向{@link OH_AudioStreamBuilder_GenerateRenderer}创建的音频流实例。 + * @param speed 设置播放的倍速值（倍速范围：0.125-4.0），值不在有效范围内不生效。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 @@ -426,7 +461,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetUnderflowCount(OH_AudioRenderer* rende * @param channelLayout 指向一个用来接收音频流声道布局的变量的指针。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数channelLayout为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetChannelLayout(OH_AudioRenderer* renderer, OH_AudioChannelLayout* channelLayout); @@ -440,7 +477,9 @@ OH_AudioStream_Result OH_AudioRenderer_GetChannelLayout(OH_AudioRenderer* render * @param effectMode 指向一个用来接收音频流音效模式的变量的指针。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数effectMode为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetEffectMode(OH_AudioRenderer* renderer, OH_AudioStream_AudioEffectMode* effectMode); @@ -468,7 +507,9 @@ OH_AudioStream_Result OH_AudioRenderer_SetEffectMode(OH_AudioRenderer* renderer, * @param privacy 用于返回当前流的内录策略。 * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数privacy为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetRendererPrivacy(OH_AudioRenderer* renderer, OH_AudioStream_PrivacyType* privacy); @@ -498,7 +539,9 @@ OH_AudioStream_Result OH_AudioRenderer_SetSilentModeAndMixWithOthers( * @param on 用于返回当前流的静音并发状态。 * @return 函数返回值： * {@link #AUDIOSTREAM_SUCCESS} 函数执行成功。 - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM} 参数renderer为nullptr。 + * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： + * 1. 参数renderer为nullptr； + * 2. 参数on为nullptr。 */ OH_AudioStream_Result OH_AudioRenderer_GetSilentModeAndMixWithOthers( OH_AudioRenderer* renderer, bool* on); diff --git a/zh-cn/native_sdk/multimedia/audio_framework/common/native_audiostreambuilder.h b/zh-cn/native_sdk/multimedia/audio_framework/common/native_audiostreambuilder.h index d13dcea2d7eb5acc5316ce6a0b76f42df2dd140f..60a6eaf466dcf59daa06d95729860775a0877315 100644 --- a/zh-cn/native_sdk/multimedia/audio_framework/common/native_audiostreambuilder.h +++ b/zh-cn/native_sdk/multimedia/audio_framework/common/native_audiostreambuilder.h @@ -54,7 +54,7 @@ extern "C" { * * @since 10 * @syscap SystemCapability.Multimedia.Audio.Core - * @param builder 该引用指向创建的构造器的结果。 + * @param builder 该引用指向创建的构造器的结果。值为nullptr会导致崩溃。 * @param type 构造器的流类型。{@link AUDIOSTREAM_TYPE_RENDERER} or {@link AUDIOSTREAM_TYPE_CAPTURER} * @return 函数返回值： * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 @@ -312,8 +312,9 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetWriteDataWithMetadataCallback(OH_ * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： * 1. 参数builder为nullptr； - * 2. StreamType无效； - * 3. 创建OHAudioRenderer失败。 + * 2. 参数audioRenderer为nullptr； + * 3. StreamType无效； + * 4. 创建OHAudioRenderer失败。 */ OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer(OH_AudioStreamBuilder* builder, OH_AudioRenderer** audioRenderer); @@ -330,8 +331,9 @@ OH_AudioStream_Result OH_AudioStreamBuilder_GenerateRenderer(OH_AudioStreamBuild * {@link AUDIOSTREAM_SUCCESS} 函数执行成功。 * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}： * 1. 参数builder为nullptr； - * 2. StreamType无效； - * 3. 创建OHAudioCapturer失败。 + * 2. 参数audioCapturer为nullptr； + * 3. StreamType无效； + * 4. 创建OHAudioCapturer失败。 */ OH_AudioStream_Result OH_AudioStreamBuilder_GenerateCapturer(OH_AudioStreamBuilder* builder, OH_AudioCapturer** audioCapturer);