程序包 ohos.media.audio

类 AudioSwiftSession

java.lang.Object

ohos.media.audio.AudioSwiftSession

public class AudioSwiftSession
extends java.lang.Object

Represents a low-latency and high-performance session for applications to play pulse-code modulation (PCM) audio.

Currently, this class is available for smart TVs only and supports only 16-bit, 48000 Hz, and dual-channel PCM data.

从以下版本开始:

5

方法概要

限定符和类型	方法	说明
boolean	close()	Closes this AudioSwiftSession instance to release audio resources.
static AudioSwiftSession	create(ohos.media.audio.AudioStreamInfo info)	Creates an AudioSwiftSession instance based on a specified AudioStreamInfo instance.
AudioSwiftTrack	getTrack()	Obtains the AudioSwiftTrack instance as the audio input track, which is used for PCM data writing.
boolean	open()	Opens this AudioSwiftSession instance and initializes audio resources.
boolean	start()	Starts this AudioSwiftSession instance.
boolean	stop()	Stops this AudioSwiftSession instance.
protected boolean	write(byte[] data, int offset, int size)	Writes PCM data.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

create

public static AudioSwiftSession create(ohos.media.audio.AudioStreamInfo info)
                                throws java.lang.IllegalArgumentException

Creates an AudioSwiftSession instance based on a specified AudioStreamInfo instance.

参数:

info - Indicates the AudioStreamInfo instance, which stores information about the audio stream to play, such as the sampling rate, PCM type, and channels.

返回:

Returns the created AudioSwiftSession instance.

抛出:

java.lang.IllegalArgumentException - Throws this exception if info is invalid.

从以下版本开始:

5

getTrack

public AudioSwiftTrack getTrack()

Obtains the AudioSwiftTrack instance as the audio input track, which is used for PCM data writing.

返回:

Returns the obtained AudioSwiftTrack instance.

从以下版本开始:

5

open

public boolean open()

Opens this AudioSwiftSession instance and initializes audio resources.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

start

public boolean start()

Starts this AudioSwiftSession instance.

PCM data can be written only after the session is started.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

stop

public boolean stop()

Stops this AudioSwiftSession instance.

PCM data writing fails after the session is stopped. You can write data again after calling start().

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

close

public boolean close()

Closes this AudioSwiftSession instance to release audio resources.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5

write

protected boolean write(byte[] data,
                        int offset,
                        int size)

Writes PCM data.

This method can be called only after the session is started by AudioSwiftSession#start(). Currently, only 16-bit, 48000 Hz, and dual-channel PCM data is supported.

参数:

data - Indicates the PCM data to write.

offset - Indicates the offset (in bytes) where the data writing starts.

size - Indicates the length (in bytes) of the PCM data to write.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

5