# AudioRender - [Overview](#section1801946826165630) - [Summary](#section1078987041165630) - [Data Fields](#pub-attribs) - [Details](#section422181551165630) - [Field](#section202261737165630) - [GetChannelMode](#aad3d5e4104167620eacb2ba23edce50e) - [GetLatency](#a56dff6bbe1c5ac8361b2e3238ab09563) - [GetRenderPosition](#a24072bec0e2cd75727b57ec3e14f7ccb) - [GetRenderSpeed](#af0a19dacb293d3fbe600902b93af1ee9) - [RenderFrame](#a463cab04d0805a5c7b3ba5884c468246) - [SetChannelMode](#ae5aad5b26ccdd65ba501620851c5ecec) - [SetRenderSpeed](#a5589427ae5a4ba6a8d2a19dd8eddbcd8) ## **Overview** **Related Modules:** [Audio](audio.md) **Description:** Provides capabilities for audio rendering, including controlling the rendering, setting audio attributes, scenes, and volume, obtaining hardware latency, and rendering audio frames. See also : [AudioControl](audiocontrol.md) : [AudioAttribute](audioattribute.md) : [AudioScene](audioscene.md) : [AudioVolume](audiovolume.md) **Since:** 1.0 **Version:** 1.0 ## **Summary** ## Data Fields

Variable Name	Description
control	struct AudioControl Defines the audio control. For details, see AudioControl.
attr	struct AudioAttribute Defines the audio attribute. For details, see AudioAttribute.
scene	struct AudioScene Defines the audio scene. For details, see AudioScene.
volume	struct AudioVolume Defines audio volume. For details, see AudioVolume.
GetLatency )(struct AudioRender render, uint32_t ms)	int32_t(* Obtains the estimated latency of the audio device driver.
RenderFrame )(struct AudioRender render, const void frame, uint64_t requestBytes, uint64_t *replyBytes)	int32_t(* Writes a frame of output data (downlink data) into the audio driver for rendering.
GetRenderPosition )(struct AudioRender render, uint64_t frames, struct AudioTimeStamp *time)	int32_t(* Obtains the last number of output audio frames.
SetRenderSpeed )(struct AudioRender *render, float speed)	int32_t(* Sets the audio rendering speed.
GetRenderSpeed )(struct AudioRender render, float speed)	int32_t(* Obtains the current audio rendering speed.
SetChannelMode )(struct AudioRender *render, enum AudioChannelMode mode)	int32_t(* Sets the channel mode for audio rendering.
GetChannelMode )(struct AudioRender render, enum AudioChannelMode mode)	int32_t(* Obtains the current channel mode for audio rendering.

## **Details** ## **Field ** ## GetChannelMode ``` int32_t(* AudioRender::GetChannelMode) (struct [AudioRender](audiorender.md) *render, enum [AudioChannelMode](audio.md#ga78aab1fafb9657451804e42b42897123) *mode) ``` **Description:** Obtains the current channel mode for audio rendering. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
mode	Indicates the pointer to the channel mode to obtain.

**Returns:** Returns **0** if the mode is successfully obtained; returns a negative value otherwise. **See also:** [SetChannelMode](audiorender.md#ae5aad5b26ccdd65ba501620851c5ecec) ## GetLatency ``` int32_t(* AudioRender::GetLatency) (struct [AudioRender](audiorender.md) *render, uint32_t *ms) ``` **Description:** Obtains the estimated latency of the audio device driver. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
ms	Indicates the pointer to the latency (in milliseconds) to be obtained.

**Returns:** Returns **0** if the latency is obtained; returns a negative value otherwise. ## GetRenderPosition ``` int32_t(* AudioRender::GetRenderPosition) (struct [AudioRender](audiorender.md) *render, uint64_t *frames, struct [AudioTimeStamp](audiotimestamp.md) *[time](time.md#gae7841e681c8c9d59818568d39553642c)) ``` **Description:** Obtains the last number of output audio frames. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
frames	Indicates the pointer to the last number of output audio frames.
time	Indicates the pointer to the timestamp associated with the frame.

**Returns:** Returns **0** if the last number is obtained; returns a negative value otherwise. **See also:** [RenderFrame](audiorender.md#a463cab04d0805a5c7b3ba5884c468246) ## GetRenderSpeed ``` int32_t(* AudioRender::GetRenderSpeed) (struct [AudioRender](audiorender.md) *render, float *speed) ``` **Description:** Obtains the current audio rendering speed. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
speed	Indicates the pointer to the current rendering speed to obtain.

**Returns:** Returns **0** if the speed is successfully obtained; returns a negative value otherwise. **See also:** [SetRenderSpeed](audiorender.md#a5589427ae5a4ba6a8d2a19dd8eddbcd8) ## RenderFrame ``` int32_t(* AudioRender::RenderFrame) (struct [AudioRender](audiorender.md) *render, const void *frame, uint64_t requestBytes, uint64_t *replyBytes) ``` **Description:** Writes a frame of output data \(downlink data\) into the audio driver for rendering. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
frame	Indicates the pointer to the frame to write.
requestBytes	Indicates the size of the frame, in bytes.
replyBytes	Indicates the pointer to the actual length (in bytes) of the audio data to write.

**Returns:** Returns **0** if the data is written successfully; returns a negative value otherwise. ## SetChannelMode ``` int32_t(* AudioRender::SetChannelMode) (struct [AudioRender](audiorender.md) *render, enum [AudioChannelMode](audio.md#ga78aab1fafb9657451804e42b42897123) mode) ``` **Description:** Sets the channel mode for audio rendering. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
mode	Indicates the channel mode to set.

**Returns:** Returns **0** if the setting is successful; returns a negative value otherwise. **See also:** [GetChannelMode](audiorender.md#aad3d5e4104167620eacb2ba23edce50e) ## SetRenderSpeed ``` int32_t(* AudioRender::SetRenderSpeed) (struct [AudioRender](audiorender.md) *render, float speed) ``` **Description:** Sets the audio rendering speed. **Parameters:**

Name	Description
render	Indicates the pointer to the AudioRender object to operate.
speed	Indicates the rendering speed to set.

**Returns:** Returns **0** if the setting is successful; returns a negative value otherwise. **See also:** [GetRenderSpeed](audiorender.md#af0a19dacb293d3fbe600902b93af1ee9)