native_audiorenderer.h

Overview

The native_audiorenderer.h file declares the functions related to an audio renderer.

Library: libohaudio.so

File to include: <ohaudio/native_audiorenderer.h>

System capability: SystemCapability.Multimedia.Audio.Core

Since: 10

Related module: OHAudio

Summary

Types

Name	Description
typedef void(* OH_AudioRenderer_OnInterruptCallback) (OH_AudioRenderer renderer, void userData, OH_AudioInterrupt_ForceType type, OH_AudioInterrupt_Hint hint)	Defines the callback for interruption events of an audio renderer.
typedef void(* OH_AudioRenderer_OnErrorCallback) (OH_AudioRenderer renderer, void userData, OH_AudioStream_Result error)	Defines the callback for error events of an audio renderer.

Functions

Name	Description
OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer *renderer)	Releases an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer *renderer)	Starts an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer *renderer)	Pauses an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_Stop(OH_AudioRenderer *renderer)	Stops an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer *renderer)	Flushes written audio data.
OH_AudioStream_Result OH_AudioRenderer_GetCurrentState(OH_AudioRenderer renderer, OH_AudioStream_State state)	Obtains the state of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetSamplingRate(OH_AudioRenderer renderer, int32_t rate)	Obtains the sampling rate of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetStreamId(OH_AudioRenderer renderer, uint32_t streamId)	Obtains the stream ID of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetChannelCount(OH_AudioRenderer renderer, int32_t channelCount)	Obtains the number of channels for an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetSampleFormat(OH_AudioRenderer renderer, OH_AudioStream_SampleFormat sampleFormat)	Obtains the sampling format of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetLatencyMode(OH_AudioRenderer renderer, OH_AudioStream_LatencyMode latencyMode)	Obtains the latency mode of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetRendererInfo(OH_AudioRenderer renderer, OH_AudioStream_Usage usage)	Obtains the usage scenario of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetEncodingType(OH_AudioRenderer renderer, OH_AudioStream_EncodingType encodingType)	Obtains the encoding type of an audio renderer.
OH_AudioStream_Result OH_AudioRenderer_GetFramesWritten(OH_AudioRenderer renderer, int64_t frames)	Obtains the number of frames that have been written since the stream was created.
OH_AudioStream_Result OH_AudioRenderer_GetTimestamp(OH_AudioRenderer renderer, clockid_t clockId, int64_t framePosition, int64_t *timestamp)	Obtains the timestamp and position information of an output audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetAudioTimestampInfo (OH_AudioRenderer renderer, int64_t framePosition, int64_t *timestamp)	Obtains the timestamp and position information of an output audio stream. It adapts to the speed adjustment interface.
OH_AudioStream_Result OH_AudioRenderer_GetFrameSizeInCallback(OH_AudioRenderer renderer, int32_t frameSize)	Obtains the frame size in the callback.
OH_AudioStream_Result OH_AudioRenderer_GetSpeed(OH_AudioRenderer renderer, float speed)	Obtains the audio renderer rate.
OH_AudioStream_Result OH_AudioRenderer_SetSpeed(OH_AudioRenderer *renderer, float speed)	Sets the audio renderer rate.
OH_AudioStream_Result OH_AudioRenderer_SetMarkPosition(OH_AudioRenderer renderer, uint32_t samplePos, OH_AudioRenderer_OnMarkReachedCallback callback, void userData)	Sets the mark position for an audio renderer. When this function is called, the mark position that has been set will be overwritten.
OH_AudioStream_Result OH_AudioRenderer_CancelMark(OH_AudioRenderer *renderer)	Cancels the mark set by OH_AudioRenderer_SetMarkPosition.
OH_AudioStream_Result OH_AudioRenderer_SetVolume(OH_AudioRenderer *renderer, float volume)	Sets the volume for an audio stream.
OH_AudioStream_Result OH_AudioRenderer_SetVolumeWithRamp(OH_AudioRenderer *renderer, float volume, int32_t durationMs)	Sets the volume with a ramp within the specified duration for an audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetVolume(OH_AudioRenderer renderer, float volume)	Obtains the volume of an audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetUnderflowCount(OH_AudioRenderer renderer, uint32_t count)	Obtains the number of underloaded audio streams of an audio capturer.
OH_AudioStream_Result OH_AudioRenderer_GetChannelLayout(OH_AudioRenderer renderer, OH_AudioChannelLayout channelLayout)	Obtains the channel layout of an audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetEffectMode(OH_AudioRenderer renderer, OH_AudioStream_AudioEffectMode effectMode)	Obtains the effect mode of an audio stream.
OH_AudioStream_Result OH_AudioRenderer_SetEffectMode(OH_AudioRenderer *renderer, OH_AudioStream_AudioEffectMode effectMode)	Sets the effect mode for an audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetRendererPrivacy(OH_AudioRenderer renderer, OH_AudioStream_PrivacyType privacy)	Checks whether the audio stream being played can be recorded by other applications.
OH_AudioStream_Result OH_AudioRenderer_SetSilentModeAndMixWithOthers(OH_AudioRenderer *renderer, bool on)	Sets the silent mode in concurrent playback for an audio stream.
OH_AudioStream_Result OH_AudioRenderer_GetSilentModeAndMixWithOthers(OH_AudioRenderer renderer, bool on)	Checks whether the silent mode in concurrent playback is enabled for an audio stream.
OH_AudioStream_Result OH_AudioRenderer_SetDefaultOutputDevice(OH_AudioRenderer *renderer, OH_AudioDevice_Type deviceType)	Sets the default built-in audio output device.