程序包 ohos.media.audio

类 AudioStreamInfo

java.lang.Object

ohos.media.audio.AudioStreamInfo

public final class AudioStreamInfo
extends Object

Provides audio stream information.

This class provides initialized parameters of AudioCapturer and AudioRenderer, including the stream encoding format, sampling rate, audio channel, usage type, content type, session ID, buffer size, clearing flag, audio source, and stream flags.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	AudioStreamInfo.AudioStreamFlag	Describes audio stream flags.
static class	AudioStreamInfo.Builder	Provides builders for AudioStreamInfo objects.
static class	AudioStreamInfo.ChannelMask	Describes the channel mask.
static class	AudioStreamInfo.ContentType	Describes types of audio stream content.
static class	AudioStreamInfo.EncodingFormat	Describes the stream encoding format.
static class	AudioStreamInfo.StreamType	Describes audio stream type.
static class	AudioStreamInfo.StreamUsage	Indicates the audio stream usage type.

字段概要

字段

限定符和类型	字段	说明
static int	SAMPLE_RATE_FOR_DIRECT_HZ_MAX	Indicates the maximum sampling rate (in Hz) for AudioRendererInfo.AudioStreamOutputFlag#AUDIO_STREAM_OUTPUT_FLAG_DIRECT.
static int	SAMPLE_RATE_HZ_MAX	Indicates the maximum sampling rate (in Hz).
static int	SAMPLE_RATE_HZ_MIN	Indicates the minimum sampling rate (in Hz).
static int	SAMPLE_RATE_UNSPECIFIED	Indicates the initial sampling rate.

方法概要

限定符和类型	方法	说明
AudioStreamInfo.AudioStreamFlag	getAudioStreamFlag()	Obtains the audio stream flag.
static int	getChannelCount(AudioStreamInfo.ChannelMask mask)	Obtains the number of audio channels contained in the specified audio channel mask.
AudioStreamInfo.ChannelMask	getChannelMask()	Obtains the channel mask of the audio stream.
AudioStreamInfo.ContentType	getContentType()	Obtains the content type of the audio stream.
AudioStreamInfo.EncodingFormat	getEncodingFormat()	Obtains the encoding format of the audio stream.
int	getSampleRate()	Obtains the sampling rate of the audio stream.
AudioStreamInfo.StreamType	getStreamType()	Obtains the audio stream type.
AudioStreamInfo.StreamUsage	getUsage()	Obtains the usage type of the audio stream.
static boolean	isValidEncodingFormat(AudioStreamInfo.EncodingFormat format)	Checks whether an encoding format is valid.
static boolean	isValidOutChannelMask(AudioStreamInfo.ChannelMask channelMask)	Checks whether the audio channel mask is valid.
String	toString()	Obtains the string representation of the AudioStreamInfo object.

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

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

字段详细资料

SAMPLE_RATE_FOR_DIRECT_HZ_MAX

public static final int SAMPLE_RATE_FOR_DIRECT_HZ_MAX

Indicates the maximum sampling rate (in Hz) for AudioRendererInfo.AudioStreamOutputFlag#AUDIO_STREAM_OUTPUT_FLAG_DIRECT.

从以下版本开始:

3

另请参阅:

常量字段值

SAMPLE_RATE_HZ_MAX

public static final int SAMPLE_RATE_HZ_MAX

Indicates the maximum sampling rate (in Hz).

从以下版本开始:

1

另请参阅:

常量字段值

SAMPLE_RATE_HZ_MIN

public static final int SAMPLE_RATE_HZ_MIN

Indicates the minimum sampling rate (in Hz).

从以下版本开始:

1

另请参阅:

常量字段值

SAMPLE_RATE_UNSPECIFIED

public static final int SAMPLE_RATE_UNSPECIFIED

Indicates the initial sampling rate.

从以下版本开始:

1

另请参阅:

常量字段值

方法详细资料

getEncodingFormat

public AudioStreamInfo.EncodingFormat getEncodingFormat()

Obtains the encoding format of the audio stream.

返回:

Returns the encoding format, which is defined in EncodingFormat.

从以下版本开始:

1

getSampleRate

public int getSampleRate()

Obtains the sampling rate of the audio stream.

返回:

Returns the sampling rate.

从以下版本开始:

1

getChannelMask

public AudioStreamInfo.ChannelMask getChannelMask()

Obtains the channel mask of the audio stream.

返回:

Returns the channel mask, which is defined in ChannelMask.

从以下版本开始:

1

getUsage

public AudioStreamInfo.StreamUsage getUsage()

Obtains the usage type of the audio stream.

返回:

Returns the usage type, which is defined in StreamUsage.

从以下版本开始:

1

getStreamType

public AudioStreamInfo.StreamType getStreamType()

Obtains the audio stream type.

返回:

Returns the audio StreamType.

从以下版本开始:

3

getContentType

public AudioStreamInfo.ContentType getContentType()

Obtains the content type of the audio stream.

返回:

Returns the content type, which is defined in ContentType.

从以下版本开始:

1

getAudioStreamFlag

public AudioStreamInfo.AudioStreamFlag getAudioStreamFlag()

Obtains the audio stream flag.

返回:

Returns the flag, which is defined in AudioStreamFlag.

从以下版本开始:

1

toString

public String toString()

Obtains the string representation of the AudioStreamInfo object.

覆盖:

toString 在类中 Object

返回:

Returns the string representation.

从以下版本开始:

1

isValidEncodingFormat

public static boolean isValidEncodingFormat(AudioStreamInfo.EncodingFormat format)

Checks whether an encoding format is valid.

参数:

format - Indicates the EncodingFormat to check.

返回:

Returns true if the encoding format is valid; returns false otherwise.

从以下版本开始:

3

isValidOutChannelMask

public static boolean isValidOutChannelMask(AudioStreamInfo.ChannelMask channelMask)

Checks whether the audio channel mask is valid.

参数:

channelMask - Indicates the audio ChannelMask to check.

返回:

Returns true if the audio channel mask is valid; returns false otherwise.

从以下版本开始:

3

getChannelCount

public static int getChannelCount(AudioStreamInfo.ChannelMask mask)

Obtains the number of audio channels contained in the specified audio channel mask.

参数:

mask - Indicates the audio ChannelMask.

返回:

Returns the number of audio channels.

从以下版本开始:

3