AudioRenderer

java.lang.Object
- ohos.media.audio.AudioRenderer

```
public class AudioRenderer
extends Object
```
Provides interfaces for applications to play, pause, and stop pulse-code modulation (PCM) audio.
This class manages and plays an audio resource for an application. Audio buffers are transferred to the audio receiver for playback.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`AudioRenderer.ChannelVolume`	Specifies the volume of audio channels.
`static class`	`AudioRenderer.PlayMode`	Describes playback modes.
`static class`	`AudioRenderer.SpeedPara`	Provides parameters related to the playback speed and pitch.
`static class`	`AudioRenderer.State`	Describes player status.

字段概要

字段
限定符和类型	字段	说明
`static int`	`ERROR`	Indicates that an operation failed.
`static int`	`ERROR_INVALID_OPERATION`	Indicates a failure caused by improper use of a method.
`static float`	`MAX_PLAYBACK_SPEED`	Indicates the maximum playback speed.
`static float`	`MIN_PLAYBACK_SPEED`	Indicates the minimum playback speed.
`static int`	`RENDERER_SESSION_ID_NONE`	Indicates the default ID of an audio playback session.
`static int`	`SUCCESS`	Indicates that an operation is successful.

构造器概要

构造器
构造器	说明
`AudioRenderer(AudioRendererInfo audioRendererInfo, AudioRenderer.PlayMode pm)`	Creates an `AudioRenderer` instance based on a specified `AudioRendererInfo` instance and playback mode.
`AudioRenderer(AudioRendererInfo audioRendererInfo, AudioRenderer.PlayMode pm, AudioDeviceDescriptor outputDevice)`	Creates an `AudioRenderer` instance based on a specified `AudioRendererInfo` instance, playback mode, and playback device.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`duckVolume()`	Decreases the volume and mixes the audio with another application that has the audio focus.
`boolean`	`flush()`	Refreshes the stream data queue of the current playback.
`AudioStreamInfo.ChannelMask`	`getAudioChannel()`	Obtains channel mask information for audio playback.
`Timestamp`	`getAudioTime()`	Obtains the playback timestamp.
`int`	`getBufferFrameSize()`	Obtains the size of frames in the audio buffer for audio playback.
`int`	`getBufferUnderflowTimes()`	Obtains the number of times that the data in the audio buffer is insufficient.
`AudioDeviceDescriptor`	`getCurrentDevice()`	Obtains information about an audio playback device.
`static float`	`getMaxVolume()`	Obtains the maximum volume allowed for the stream playback.
`static int`	`getMinBufferSize(int sampleRate, AudioStreamInfo.EncodingFormat format, AudioStreamInfo.ChannelMask channelMask)`	Obtains the minimum buffer size required to ensure normal audio stream playback in `PlayMode#MODE_STREAM` mode.
`static float`	`getMinVolume()`	Obtains the minimum volume allowed for the stream playback.
`AudioRenderer.SpeedPara`	`getPlaybackSpeed()`	Obtains the playback speed and pitch parameters.
`int`	`getPosition()`	Obtains the playback position, which is represented by the number of audio frames played.
`AudioRendererInfo`	`getRendererInfo()`	Gets the audio renderer info.
`int`	`getRendererSessionId()`	Obtains the audio rendering session ID.
`int`	`getSampleRate()`	Obtains the sampling rate.
`AudioRenderer.State`	`getState()`	Obtains audio playback status.
`AudioStreamInfo.StreamType`	`getStreamType()`	Obtains the audio stream type for the playback.
`boolean`	`pause()`	Pauses audio stream playback.
`boolean`	`release()`	Releases playback resources.
`void`	`setFrameIntervalObserver(FrameIntervalObserver observer, int interval, EventHandler handler)`	Sets an observer to listen for the event that the playback progress reaches a multiple of `interval`.
`void`	`setFramePositionObserver(FramePositionObserver observer, int position, EventHandler handler)`	Sets an observer to listen for the event that the playback progress reaches a specified position.
`boolean`	`setOutputDevice(AudioDeviceDescriptor info)`	Sets the audio stream playback device.
`boolean`	`setPlaybackSpeed(AudioRenderer.SpeedPara speedPara)`	Sets playback speed and pitch parameters.
`boolean`	`setPosition(int position)`	Sets the position to start audio stream playback, which is represented by frames.
`boolean`	`setSampleRate(int sampleRateInHz)`	Sets the audio stream sampling rate.
`boolean`	`setSendEffect(int effectId)`	Sets a send effect for audio playback.
`void`	`setSendEffectLevel(float level)`	Sets the level of the send effect for audio playback.
`boolean`	`setSpeed(float speed)`	Sets the playback speed.
`boolean`	`setVolume(float vol)`	Sets output volume for all audio channels.
`boolean`	`setVolume(AudioRenderer.ChannelVolume channelVolume)`	Sets output volume for an audio channel.
`boolean`	`start()`	Plays audio streams.
`boolean`	`stop()`	Stops playing audio streams.
`boolean`	`unduckVolume()`	Restores the volume.
`boolean`	`write(byte[] data, int offset, int size)`	Writes audio data to an audio receiver for playback in `MODE_STREAM` mode, or copies the audio data for later playback in `MODE_STATIC` mode.
`boolean`	`write(float[] data, int offset, int size)`	Writes the specified type of audio data into an audio receiver for playback in `MODE_STREAM` mode, or copies the audio data for later playback in `MODE_STATIC` mode.
`boolean`	`write(short[] data, int offset, int size)`	Writes audio data to an audio receiver for playback in `MODE_STREAM` mode, or copies the audio data for later playback in `MODE_STATIC` mode.
`boolean`	`write(ByteBuffer data, int size)`	Writes `ByteBuffer` audio data into an audio receiver for playback in `MODE_STREAM` mode, or copies the audio data for later playback in `MODE_STATIC` mode.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ERROR
```
public static final int ERROR
```
    Indicates that an operation failed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - ERROR_INVALID_OPERATION
```
public static final int ERROR_INVALID_OPERATION
```
    Indicates a failure caused by improper use of a method.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MAX_PLAYBACK_SPEED
```
public static final float MAX_PLAYBACK_SPEED
```
    Indicates the maximum playback speed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - MIN_PLAYBACK_SPEED
```
public static final float MIN_PLAYBACK_SPEED
```
    Indicates the minimum playback speed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - RENDERER_SESSION_ID_NONE
```
public static final int RENDERER_SESSION_ID_NONE
```
    Indicates the default ID of an audio playback session.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SUCCESS
```
public static final int SUCCESS
```
    Indicates that an operation is successful.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AudioRenderer
```
public AudioRenderer(AudioRendererInfo audioRendererInfo,
                     AudioRenderer.PlayMode pm)
              throws IllegalArgumentException
```
    Creates an AudioRenderer instance based on a specified AudioRendererInfo instance and playback mode. The playback device is the default one.
    
    参数:
    
    audioRendererInfo - Indicates information about the audio streams to play.
    
    pm - Indicates the stream playback mode.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if a parameter is invalid.
    
    从以下版本开始:
    
    2
  - AudioRenderer
```
public AudioRenderer(AudioRendererInfo audioRendererInfo,
                     AudioRenderer.PlayMode pm,
                     AudioDeviceDescriptor outputDevice)
              throws IllegalArgumentException
```
    Creates an AudioRenderer instance based on a specified AudioRendererInfo instance, playback mode, and playback device.
    
    参数:
    
    audioRendererInfo - Indicates information about the audio streams to play.
    
    pm - Indicates the stream playback mode.
    
    outputDevice - Indicates information about the preference output device of this AudioRenderer.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if a parameter is invalid.
    
    从以下版本开始:
    
    2
- 方法详细资料
  - getState
```
public AudioRenderer.State getState()
```
    Obtains audio playback status.
    
    返回:
    
    Returns audio playback status, which is defined by State.
    
    从以下版本开始:
    
    1
  - start
```
public boolean start()
```
    Plays audio streams.
    To play audio streams in MODE_STATIC mode, you need to call the write method before this method.
    
    返回:
    
    Returns true if the audio streams are played; returns false otherwise.
    
    从以下版本开始:
    
    1
  - pause
```
public boolean pause()
```
    Pauses audio stream playback.
    
    返回:
    
    Returns true if the playback is paused; returns false otherwise.
    
    从以下版本开始:
    
    1
  - stop
```
public boolean stop()
```
    Stops playing audio streams.
    
    返回:
    
    Returns true if the playback is stopped; returns false otherwise.
    
    从以下版本开始:
    
    1
  - release
```
public boolean release()
```
    Releases playback resources.
    
    返回:
    
    Returns true if the resources are released; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getMinBufferSize
```
public static int getMinBufferSize(int sampleRate,
                                   AudioStreamInfo.EncodingFormat format,
                                   AudioStreamInfo.ChannelMask channelMask)
```
    Obtains the minimum buffer size required to ensure normal audio stream playback in PlayMode#MODE_STREAM mode.
    
    参数:
    
    sampleRate - Indicates the sampling rate of the audio stream.
    
    format - Indicates the encoding format of the audio stream.
    
    channelMask - Indicates the audio channel mask.
    
    返回:
    
    Returns the buffer size (in bytes) if obtained; returns a value less than or equal to 0 otherwise.
    
    从以下版本开始:
    
    3
  - write
```
public boolean write(short[] data,
                     int offset,
                     int size)
```
    Writes audio data to an audio receiver for playback in MODE_STREAM mode, or copies the audio data for later playback in MODE_STATIC mode.
    This is a synchronous method that returns the result until all the data is written. You can set a short integer array to write audio data for both MODE_STREAM and MODE_STATIC playback.
    
    参数:
    
    data - Indicates data to be written.
    
    offset - Indicates the offset (in shorts), which defines the beginning placement to write the data.
    
    size - Indicates the shorts of data to be written.
    
    返回:
    
    Returns true if the data is written; returns false otherwise.
    
    从以下版本开始:
    
    1
  - write
```
public boolean write(byte[] data,
                     int offset,
                     int size)
```
    Writes audio data to an audio receiver for playback in MODE_STREAM mode, or copies the audio data for later playback in MODE_STATIC mode.
    You can set a byte array to write audio data for both MODE_STREAM and MODE_STATIC playback.
    
    参数:
    
    data - Indicates data to be written.
    
    offset - Indicates the offset (in bytes), which defines the beginning placement to write the data.
    
    size - Indicates the bytes of data to be written.
    
    返回:
    
    Returns true if the data is written; returns false otherwise.
    
    从以下版本开始:
    
    1
  - write
```
public boolean write(float[] data,
                     int offset,
                     int size)
```
    Writes the specified type of audio data into an audio receiver for playback in MODE_STREAM mode, or copies the audio data for later playback in MODE_STATIC mode.
    This is a synchronous method that returns the result until all the data is written. You can set a float array to write audio data for both MODE_STREAM and MODE_STATIC playback.
    
    参数:
    
    data - Indicates the data to be written.
    
    offset - Indicates the offset into which the data will be written.
    
    size - Indicates the size of the float data to be written.
    
    返回:
    
    Returns true if the data is written; returns false otherwise.
    
    从以下版本开始:
    
    3
  - write
```
public boolean write(ByteBuffer data,
                     int size)
```
    Writes ByteBuffer audio data into an audio receiver for playback in MODE_STREAM mode, or copies the audio data for later playback in MODE_STATIC mode.
    You can set a ByteBuffer instance to write audio data for both MODE_STREAM and MODE_STATIC playback.
    
    参数:
    
    data - Indicates the data to be written.
    
    size - Indicates the size of the ByteBuffer data to be written.
    
    返回:
    
    Returns true if the data is written; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setVolume
```
public boolean setVolume(float vol)
```
    Sets output volume for all audio channels.
    You can use vol to set the same volume for both left and right channels.
    
    参数:
    
    vol - Indicates the output volume.
    
    返回:
    
    Returns true if the volume is set; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setVolume
```
public boolean setVolume(AudioRenderer.ChannelVolume channelVolume)
```
    Sets output volume for an audio channel.
    This method sets left and right channel volume based on the value defined in ChannelVolume.
    
    参数:
    
    channelVolume - Indicates the channel volume defined in ChannelVolume.
    
    返回:
    
    Returns true if the volume is set; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setPosition
```
public boolean setPosition(int position)
```
    Sets the position to start audio stream playback, which is represented by frames. This method is valid only for the playback in PlayMode#MODE_STATIC mode when the playback is stopped or paused.
    
    参数:
    
    position - Indicates the position to start audio stream playback, which is represented by frames.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setSpeed
```
public boolean setSpeed(float speed)
```
    Sets the playback speed.
    
    参数:
    
    speed - Indicates the playback speed, which must be greater than 0.0f.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setPlaybackSpeed
```
public boolean setPlaybackSpeed(AudioRenderer.SpeedPara speedPara)
```
    Sets playback speed and pitch parameters.
    
    参数:
    
    speedPara - Indicates the speed and pitch parameters defined in the SpeedPara instance.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setSampleRate
```
public boolean setSampleRate(int sampleRateInHz)
```
    Sets the audio stream sampling rate.
    
    参数:
    
    sampleRateInHz - Indicates the sampling rate, which must be an integer greater than 0.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setOutputDevice
```
public boolean setOutputDevice(AudioDeviceDescriptor info)
```
    Sets the audio stream playback device.
    
    参数:
    
    info - Indicates the AudioDeviceDescriptor instance describing the device information to be set. .
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getCurrentDevice
```
public AudioDeviceDescriptor getCurrentDevice()
```
    Obtains information about an audio playback device.
    The audio playback device is set using the AudioRenderer#AudioRenderer(AudioRendererInfo, PlayMode, AudioDeviceDescriptor) method.
    
    返回:
    
    Returns the device information if any device is playing audio; returns null otherwise.
    
    从以下版本开始:
    
    1
  - getRendererSessionId
```
public int getRendererSessionId()
```
    Obtains the audio rendering session ID.
    
    返回:
    
    Returns the ID of the audio rendering session where this AudioRenderer belongs to.
    
    从以下版本开始:
    
    1
  - getSampleRate
```
public int getSampleRate()
```
    Obtains the sampling rate.
    
    返回:
    
    Returns the sampling rate.
    
    从以下版本开始:
    
    2
  - getPosition
```
public int getPosition()
```
    Obtains the playback position, which is represented by the number of audio frames played.
    The number of frames is a non-negative int value that continuously increases. It will be wrapped periodically, for example, once every 27 hours around for playback of 44.1 kHz audio streams. After the number of frames exceeds the value range of an int, the value will be reset to 0.
    
    返回:
    
    Returns the position represented by the number of played frames.
    
    从以下版本开始:
    
    2
  - getAudioTime
```
public Timestamp getAudioTime()
```
    Obtains the playback timestamp.
    You need to ensure that the timestamp is obtained during the audio stream playback. You can call getState() to check the playback state. In non-playback state, you should obtain the new timestamp periodically until you get the playback timestamp.
    
    Frequent calling of this method will cause low efficiency. The recommended frequency is no more than once every 15 seconds.
    
    返回:
    
    Returns the audio playback Timestamp if obtained; returns a Timestamp with its member variables set to 0 otherwise.
    
    从以下版本开始:
    
    3
  - flush
```
public boolean flush()
```
    Refreshes the stream data queue of the current playback.
    Any data that has been written but not yet consumed will be discarded. This method is valid only for the playback in PlayMode#MODE_STREAM mode and when the playback is stopped or paused.
    
    返回:
    
    Returns true if the operation is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getPlaybackSpeed
```
public AudioRenderer.SpeedPara getPlaybackSpeed()
```
    Obtains the playback speed and pitch parameters.
    
    返回:
    
    Returns the SpeedPara instance containing the speed and pitch parameters.
    
    从以下版本开始:
    
    3
  - getMaxVolume
```
public static float getMaxVolume()
```
    Obtains the maximum volume allowed for the stream playback.
    
    返回:
    
    Returns the maximum volume.
    
    从以下版本开始:
    
    3
  - getMinVolume
```
public static float getMinVolume()
```
    Obtains the minimum volume allowed for the stream playback.
    
    返回:
    
    Returns the minimum volume.
    
    从以下版本开始:
    
    3
  - getStreamType
```
public AudioStreamInfo.StreamType getStreamType()
```
    Obtains the audio stream type for the playback.
    
    返回:
    
    Returns the audio StreamType.
    
    从以下版本开始:
    
    3
  - getRendererInfo
```
public AudioRendererInfo getRendererInfo()
```
    Gets the audio renderer info.
    
    返回:
    
    the the audio render info, which is defined in AudioRendererInfo.
    
    从以下版本开始:
    
    3
  - getBufferFrameSize
```
public int getBufferFrameSize()
```
    Obtains the size of frames in the audio buffer for audio playback.
    
    返回:
    
    Returns the frame size.
    
    从以下版本开始:
    
    4
  - setSendEffect
```
public boolean setSendEffect(int effectId)
```
    Sets a send effect for audio playback.
    
    参数:
    
    effectId - Identifies the send effect to set.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    4
  - getAudioChannel
```
public AudioStreamInfo.ChannelMask getAudioChannel()
```
    Obtains channel mask information for audio playback.
    
    返回:
    
    Returns the AudioStreamInfo.ChannelMask object.
    
    从以下版本开始:
    
    4
  - getBufferUnderflowTimes
```
public int getBufferUnderflowTimes()
```
    Obtains the number of times that the data in the audio buffer is insufficient. Playback stalls may occur when the audio buffer data is insufficient.
    
    返回:
    
    Returns the number of times that the buffer data is insufficient.
    
    从以下版本开始:
    
    4
  - setSendEffectLevel
```
public void setSendEffectLevel(float level)
```
    Sets the level of the send effect for audio playback.
    
    参数:
    
    level - Indicates the effect level to set. The value ranges from 0.0 to 1.0.
    
    从以下版本开始:
    
    4
  - setFramePositionObserver
```
public void setFramePositionObserver(FramePositionObserver observer,
                                     int position,
                                     EventHandler handler)
```
    Sets an observer to listen for the event that the playback progress reaches a specified position.
    
    参数:
    
    observer - Indicates the observer to set.
    
    position - Indicates the playback position.
    
    handler - Indicates the event handler to invoke the observer. If you do not specify a handler, the default one will be used.
    
    从以下版本开始:
    
    4
  - setFrameIntervalObserver
```
public void setFrameIntervalObserver(FrameIntervalObserver observer,
                                     int interval,
                                     EventHandler handler)
```
    Sets an observer to listen for the event that the playback progress reaches a multiple of interval.
    
    参数:
    
    observer - Indicates the observer to set.
    
    interval - Indicates the audio frame interval.
    
    handler - Indicates the event handler to invoke the observer. If you do not specify a handler, the default one will be used.
    
    从以下版本开始:
    
    4
  - duckVolume
```
public boolean duckVolume()
```
    Decreases the volume and mixes the audio with another application that has the audio focus. You can use unduckVolume() to restore the volume.
    This method is called when your application is notified by audio focus callback AudioInterrupt.InterruptListener.onInterrupt(int, int), with input parameters type and hint set to AudioInterrupt.INTERRUPT_TYPE_BEGIN and AudioInterrupt.INTERRUPT_HINT_NONE, respectively.
    
    返回:
    
    Returns true if the volume is decreased; returns false otherwise.
    
    从以下版本开始:
    
    3
  - unduckVolume
```
public boolean unduckVolume()
```
    Restores the volume. You can call this method after duckVolume().
    This method is called when your application is notified by audio focus callback AudioInterrupt.InterruptListener.onInterrupt(int, int), with input parameters type and hint set to AudioInterrupt.INTERRUPT_TYPE_END and AudioInterrupt.INTERRUPT_HINT_RESUME, respectively.
    
    返回:
    
    Returns true if the volume is restored; returns false otherwise.
    
    从以下版本开始:
    
    3

类 AudioRenderer

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ERROR

ERROR_INVALID_OPERATION

MAX_PLAYBACK_SPEED

MIN_PLAYBACK_SPEED

RENDERER_SESSION_ID_NONE

SUCCESS

构造器详细资料

AudioRenderer

AudioRenderer

方法详细资料

getState

start

pause

stop

release

getMinBufferSize

write

write

write

write

setVolume

setVolume

setPosition

setSpeed

setPlaybackSpeed

setSampleRate

setOutputDevice

getCurrentDevice

getRendererSessionId

getSampleRate

getPosition

getAudioTime

flush

getPlaybackSpeed

getMaxVolume

getMinVolume

getStreamType

getRendererInfo

getBufferFrameSize

setSendEffect

getAudioChannel

getBufferUnderflowTimes

setSendEffectLevel

setFramePositionObserver

setFrameIntervalObserver

duckVolume

unduckVolume