SoundPlayer

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

```
public class SoundPlayer
extends Object
```
Manages and plays audio resources of an application.
This class provides applications with the createSound and play interfaces at the kit layer to preload and play audio resources, including sounds and tones.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`SoundPlayer.AudioVolumes`	Sets the volume of audio channels.
`static interface`	`SoundPlayer.OnCreateCompleteListener`	Listener used to monitor the successful creation of sound resources, using in `setOnCreateCompleteListener`.
`static class`	`SoundPlayer.SoundPlayerParameters`	Provides `SoundPlayer` parameters for a playback task.
`static class`	`SoundPlayer.SoundType`	Indicates the system sound type.

构造器概要

构造器
构造器	说明
`SoundPlayer()`	Default constructor used for tone playback.
`SoundPlayer(int taskType)`	A constructor used to create a `SoundPlayer` instance.
`SoundPlayer(String packageName)`	A constructor used to create a `SoundPlayer` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`createSound(FileDescriptor fd, long offset, long length)`	Creates and loads sound data from a file based on its descriptor.
`int`	`createSound(String path)`	Creates and loads sound data from a specified path.
`int`	`createSound(String path, AudioRendererInfo rendererInfo)`	Creates a sound based on the audio data and playback information loaded from a specified path.
`int`	`createSound(Context context, int resourceId)`	Creates and loads sound data based on the application context and audio resource ID.
`int`	`createSound(BaseFileDescriptor baseFileDescriptor)`	Creates and loads sound data from the specified `BaseFileDescriptor` instance.
`boolean`	`createSound(AudioStreamInfo.StreamType streamType, float volume)`	Creates a dual-tone multiple-frequency tone with specified stream type and tone volume.
`boolean`	`createSound(ToneDescriptor.ToneType type, int durationMs)`	Creates a dual-tone multiple-frequency (DTMF) tone with specified tone frequency description and duration (ms).
`boolean`	`deleteSound(int soundId)`	Deletes a sound based on its ID and releases the resources occupied.
`boolean`	`pause()`	Pauses the playback of a tone.
`boolean`	`pause(int taskId)`	Pauses the playback of a sound based on the task ID.
`boolean`	`pauseAll()`	Pauses all ongoing playback tasks.
`boolean`	`play()`	Plays a created tone.
`int`	`play(int soundId)`	Plays a sound using the default parameters.
`int`	`play(int soundId, SoundPlayer.SoundPlayerParameters parameters)`	Plays a sound using specified parameters.
`boolean`	`play(ToneDescriptor.ToneType toneType, int durationMs)`	Plays a created tone with toneType and tone duration millisecond.
`boolean`	`playSound(SoundPlayer.SoundType type)`	Plays a sound in a special effect.
`boolean`	`playSound(SoundPlayer.SoundType type, float volume)`	Plays the sound in a special effect at a specified volume.
`boolean`	`release()`	Releases resources used for tone playback.
`boolean`	`resume(int taskId)`	Resumes a sound playback task.
`boolean`	`resumeAll()`	Resumes all paused tasks.
`boolean`	`setLoop(int taskId, int loopNum)`	Sets the loop number of a sound playback task.
`boolean`	`setOnCreateCompleteListener(SoundPlayer.OnCreateCompleteListener listener)`	Sets the callback that listens for the completion of sound creation.
`boolean`	`setOnCreateCompleteListener(SoundPlayer.OnCreateCompleteListener listener, boolean isDiscarded)`	Sets the callback that listens for the completion of sound creation, and determines whether to discard original messages in the queue based on the specified `isDiscarded`.
`boolean`	`setPlaySpeedRate(int taskId, float speedRate)`	Sets the playback speed of a sound playback task.
`boolean`	`setPriority(int taskId, int priority)`	Sets the priority of a sound playback task.
`boolean`	`setVolume(int taskId, float volume)`	Sets the volume of all audio channels for a sound playback task.
`boolean`	`setVolume(int taskId, SoundPlayer.AudioVolumes audioVolumes)`	Sets the volume of an audio channel for a sound playback task.
`boolean`	`stop(int taskId)`	Stops a sound playback task.

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

- 构造器详细资料
  - SoundPlayer
```
public SoundPlayer()
```
    Default constructor used for tone playback.
    It is a no-argument constructor and is used only for playing tones.
    
    从以下版本开始:
    
    1
  - SoundPlayer
```
public SoundPlayer(String packageName)
```
    A constructor used to create a SoundPlayer instance.
    An instance of this class is created based on the name of an application installation package.
    
    参数:
    
    packageName - Indicates the name of an application installation package.
    
    从以下版本开始:
    
    1
  - SoundPlayer
```
public SoundPlayer(int taskType)
```
    A constructor used to create a SoundPlayer instance.
    An instance of this class is created based on the type of an audio task.
    
    参数:
    
    taskType - Indicates the audio task type, which is specified by AudioManager.AudioVolumeType.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - playSound
```
public boolean playSound(SoundPlayer.SoundType type)
```
    Plays a sound in a special effect.
    
    参数:
    
    type - Indicates the sound effect type, which is specified by SoundType.
    
    返回:
    
    Returns true if the sound is played in a special effect; returns false otherwise.
    
    从以下版本开始:
    
    1
  - playSound
```
public boolean playSound(SoundPlayer.SoundType type,
                         float volume)
```
    Plays the sound in a special effect at a specified volume.
    
    参数:
    
    type - Indicates the sound effect type, which is specified by SoundType.
    
    volume - Indicates the volume of the sound effect.
    
    返回:
    
    Returns true if the sound is played in a special effect at a specified volume; returns false otherwise.
    
    从以下版本开始:
    
    1
  - createSound
```
public final boolean createSound(ToneDescriptor.ToneType type,
                                 int durationMs)
```
    Creates a dual-tone multiple-frequency (DTMF) tone with specified tone frequency description and duration (ms).
    You can use this method to create a tone, for example, a dial tone.
    
    参数:
    
    type - Indicates the tone type, which is specified by ToneDescriptor.ToneType.
    
    durationMs - Indicates the duration of the tone, in ms.
    
    返回:
    
    Returns true if the DTMF tone is created; returns false otherwise.
    
    从以下版本开始:
    
    1
  - createSound
```
public final boolean createSound(AudioStreamInfo.StreamType streamType,
                                 float volume)
```
    Creates a dual-tone multiple-frequency tone with specified stream type and tone volume.
    
    参数:
    
    streamType - Indicates the stream type for tone playing, defined by AudioStreamInfo.StreamType.
    
    volume - Indicates the volume of tone, the value ranges from 0.0 to 1.0.
    
    返回:
    
    Returns true if the tone is created; returns false otherwise.
    
    从以下版本开始:
    
    3
  - createSound
```
public final int createSound(String path)
```
    Creates and loads sound data from a specified path.
    You can use this method to create a sound, for example, knocking or footsteps.
    
    参数:
    
    path - Indicates the path for creating a sound.
    
    返回:
    
    Returns the ID of the sound, which is used to identify a sound to be played or deleted.
    
    从以下版本开始:
    
    1
  - createSound
```
public final int createSound(BaseFileDescriptor baseFileDescriptor)
```
    Creates and loads sound data from the specified BaseFileDescriptor instance.
    You can use this method to create a sound, for example, of knocking or footsteps.
    
    参数:
    
    baseFileDescriptor - Indicates the BaseFileDescriptor instance.
    
    返回:
    
    Returns the ID of the sound.
    
    从以下版本开始:
    
    3
  - createSound
```
public final int createSound(Context context,
                             int resourceId)
```
    Creates and loads sound data based on the application context and audio resource ID.
    You can use this method to create a sound, for example, of knocking or footsteps.
    
    参数:
    
    context - Indicates the application context.
    
    resourceId - Indicates the audio resource ID, for example, Resource.Raw.knocking.
    
    返回:
    
    Returns the ID of the sound.
    
    从以下版本开始:
    
    3
  - createSound
```
public final int createSound(FileDescriptor fd,
                             long offset,
                             long length)
```
    Creates and loads sound data from a file based on its descriptor.
    You can use this method to create a sound, for example, of knocking or footsteps.
    
    参数:
    
    fd - Indicates the file descriptor.
    
    offset - Indicates the offset form which the data will be loaded.
    
    length - Indicates the size of the file.
    
    返回:
    
    Returns the ID of the sound.
    
    从以下版本开始:
    
    3
  - createSound
```
public final int createSound(String path,
                             AudioRendererInfo rendererInfo)
```
    Creates a sound based on the audio data and playback information loaded from a specified path.
    You can set only the AudioStreamInfo#streamUsage, AudioStreamInfo#contentType, and AudioStreamInfo#streamFlag parameters in the AudioRendererInfo object. Other information, such as AudioRendererInfo#bufferSizeInBytes and AudioStreamInfo#sampleRate, loaded from the specified file cannot be configured.
    
    参数:
    
    path - Indicates the path from which the data is loaded.
    
    rendererInfo - Indicates the playback parameters. You can set some of them to implement specific functions, for example, setting the sound usage type.
    
    返回:
    
    Returns the ID of the sound if it is created; returns 0 otherwise.
    
    从以下版本开始:
    
    3
  - deleteSound
```
public final boolean deleteSound(int soundId)
```
    Deletes a sound based on its ID and releases the resources occupied.
    You can use this method to release resources occupied by the sound in the case of insufficient resources.
    
    参数:
    
    soundId - Indicates the sound ID.
    
    返回:
    
    Returns true if the resources are released; returns false otherwise.
    
    从以下版本开始:
    
    1
  - play
```
public final boolean play(ToneDescriptor.ToneType toneType,
                          int durationMs)
```
    Plays a created tone with toneType and tone duration millisecond.
    You can use SoundPlayer#createSound(AudioStreamInfo.StreamType, float) to create a tone, and then invoke this method to play it.
    
    参数:
    
    toneType - Indicates the tone type, which is specified by ToneDescriptor.ToneType.
    
    durationMs - Indicates the duration millisecond of the tone (infinite duration time = -1).
    
    返回:
    
    Returns true if the tone is played; returns false otherwise.
    
    从以下版本开始:
    
    3
  - play
```
public final boolean play()
```
    Plays a created tone.
    You can use SoundPlayer#createSound(ToneDescriptor.ToneType, int) to create a tone, and then invoke this method to play it.
    
    返回:
    
    Returns true if the tone is played; returns false otherwise.
    
    从以下版本开始:
    
    1
  - play
```
public final int play(int soundId)
```
    Plays a sound using the default parameters.
    
    参数:
    
    soundId - Indicates the ID of the sound to be played.
    
    返回:
    
    Returns true if the sound is played; returns false otherwise.
    
    从以下版本开始:
    
    1
  - play
```
public final int play(int soundId,
                      SoundPlayer.SoundPlayerParameters parameters)
```
    Plays a sound using specified parameters.
    
    参数:
    
    soundId - Indicates the ID of the sound to be played.
    
    parameters - Indicates the playback parameters, such as the playback priority, playback speed, and loop number.
    
    返回:
    
    Returns true if the sound is played; returns false otherwise.
    
    从以下版本开始:
    
    1
  - pause
```
public final boolean pause()
```
    Pauses the playback of a tone.
    
    返回:
    
    Returns true if the tone playback is paused; returns false otherwise.
    
    从以下版本开始:
    
    1
  - pause
```
public final boolean pause(int taskId)
```
    Pauses the playback of a sound based on the task ID.
    
    参数:
    
    taskId - Indicates the ID of a playback task.
    
    返回:
    
    Returns true if the sound playback is paused; returns false otherwise.
    
    从以下版本开始:
    
    1
  - resume
```
public final boolean resume(int taskId)
```
    Resumes a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    返回:
    
    Returns true if the playback task is resumed; returns false otherwise.
    
    从以下版本开始:
    
    1
  - stop
```
public final boolean stop(int taskId)
```
    Stops a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - release
```
public final boolean release()
```
    Releases resources used for tone playback.
    You can use this method to release resources occupied by the tone in the case of insufficient resources.
    
    返回:
    
    Returns true if the tone resources are released; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setVolume
```
public final boolean setVolume(int taskId,
                               SoundPlayer.AudioVolumes audioVolumes)
```
    Sets the volume of an audio channel for a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    audioVolumes - Indicates the volume of an audio channel. The value ranges from 0.0 to 1.0. The value 0.0 indicates that the audio channel is muted, and the value 1.0 indicates the maximum volume of the audio channel. The audio channels include the left, right, and surround channels.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setVolume
```
public final boolean setVolume(int taskId,
                               float volume)
```
    Sets the volume of all audio channels for a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    volume - Indicates the volume of a playback task. The value ranges from 0.0 to 1.0. The value 0.0 means that all the audio channels are muted, and the value 1.0 means the maximum volume of all the audio channels.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setPriority
```
public final boolean setPriority(int taskId,
                                 int priority)
```
    Sets the priority of a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    priority - Indicates the priority. The value 0 means that the sound will be played immediately, and the value 1 means that the sound will be played at a later time.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setPlaySpeedRate
```
public final boolean setPlaySpeedRate(int taskId,
                                      float speedRate)
```
    Sets the playback speed of a sound playback task.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    speedRate - Indicates the playback speed. The value is a floating-point number ranging from 0.5 to 2.0. The value 1.0 indicates normal playback speed.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setLoop
```
public final boolean setLoop(int taskId,
                             int loopNum)
```
    Sets the loop number of a sound playback task.
    You can use this method to set the number of times that a sound will be played.
    
    参数:
    
    taskId - Indicates the ID of a playback task, which is the return value of SoundPlayer#play(int).
    
    loopNum - Indicates the loop number. The value is an integer greater than or equal to -1. The value 0 indicates that the sound does not loop, and the value -1 indicates that the sound loops without an end.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - pauseAll
```
public final boolean pauseAll()
```
    Pauses all ongoing playback tasks.
    
    返回:
    
    Returns true if all tasks are paused; returns false otherwise.
    
    从以下版本开始:
    
    3
  - resumeAll
```
public final boolean resumeAll()
```
    Resumes all paused tasks.
    
    返回:
    
    Returns true if all paused tasks are resumed; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setOnCreateCompleteListener
```
public boolean setOnCreateCompleteListener(SoundPlayer.OnCreateCompleteListener listener)
```
    Sets the callback that listens for the completion of sound creation.
    createSound() is an asynchronous method, which immediately returns upon calling. You can set the OnCreateCompleteListener to receive the notification, and then specify subsequent operations in onCreateComplete provided by OnCreateCompleteListener.
    
    参数:
    
    listener - Indicates the OnCreateCompleteListener instance set for the completion of sound creation.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setOnCreateCompleteListener
```
public boolean setOnCreateCompleteListener(SoundPlayer.OnCreateCompleteListener listener,
                                           boolean isDiscarded)
```
    Sets the callback that listens for the completion of sound creation, and determines whether to discard original messages in the queue based on the specified isDiscarded.
    
    参数:
    
    listener - Indicates the OnCreateCompleteListener instance set for the completion of sound creation.
    
    isDiscarded - Specifies whether the original messages in the queue will be discarded. value true indicates the messages will be discarded, and false indicates the opposite.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3

类 SoundPlayer

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

SoundPlayer

SoundPlayer

SoundPlayer

方法详细资料

playSound

playSound

createSound

createSound

createSound

createSound

createSound

createSound

createSound

deleteSound

play

play

play

play

pause

pause

resume

stop

release

setVolume

setVolume

setPriority

setPlaySpeedRate

setLoop

pauseAll

resumeAll

setOnCreateCompleteListener

setOnCreateCompleteListener