Audio

概述

Audio模块接口定义。

音频接口涉及自定义类型、驱动加载接口、驱动适配器接口、音频播放（Render）接口、音频录音（Capture）接口等。

Since:

1.0

Version:

1.0

汇总

文件

类

类型定义

枚举

函数

变量

类型定义说明

RenderCallback

typedef int32_t(* RenderCallback) (enum AudioCallbackType, void *reserved, void *cookie)

描述:

回调函数指针。

参数:

返回:

成功返回值0，失败返回负值。

参见:

RegCallback

枚举类型说明

AudioCallbackType

enum AudioCallbackType

描述:

回调函数通知事件类型。

AudioCategory

enum AudioCategory

描述:

音频类型（category）。

AudioChannelMask

enum AudioChannelMask

描述:

音频通道掩码（mask）。

定义音频声道的位置。

AudioChannelMode

enum AudioChannelMode

描述:

音频播放的通道模式。

注意:

下面的模式是针对双通道立体声的音频播放而设置，其他不支持。

AudioDrainNotifyType

enum AudioDrainNotifyType

描述:

DrainBuffer函数结束类型。

AudioFormat

enum AudioFormat

描述:

音频格式。

AudioPortDirection

enum AudioPortDirection

描述:

音频端口的类型。

AudioPortPassthroughMode

enum AudioPortPassthroughMode

描述:

音频端口的数据透传模式。

AudioPortPin

enum AudioPortPin

描述:

音频适配器端口的PIN脚。

AudioPortRole

enum AudioPortRole

描述:

音频端口角色。

AudioPortType

enum AudioPortType

描述:

音频端口类型。

AudioSampleFormat

enum AudioSampleFormat

描述:

原始音频样本格式。

AudioSampleRatesMask

enum AudioSampleRatesMask

描述:

音频采样频率MASK。

AudioSessionType

enum AudioSessionType

描述:

端口会话类型。

函数说明

GetAudioManagerFuncs()

struct AudioManager* GetAudioManagerFuncs (void )

描述:

获取音频适配器管理接口的操作函数列表，详情参考AudioManager。

返回:

成功返回一个音频适配器管理接口的对象，失败返回NULL。

变量说明

adapterName

const char* AudioAdapterDescriptor::adapterName

描述:

音频适配器的名称

channelCount [1/2]

uint32_t AudioSampleAttributes::channelCount

描述:

音频通道数目，如单通道（mono）为1、立体声（stereo）为2。

channelCount [2/2]

unsigned int AudioPortCapability::channelCount

描述:

支持的最大声道总数

channelMasks

enum AudioChannelMask AudioPortCapability::channelMasks

描述:

设备的声道布局掩码（mask），详情参考AudioChannelMask。

desc [1/5]

const char* AudioDeviceDescriptor::desc

描述:

以字符串命名的音频设备

desc [2/5]

struct AudioDeviceDescriptor AudioSceneDescriptor::desc

描述:

音频设备描述符

desc [3/5]

const char* AudioSceneDescriptor::SceneDesc::desc

描述:

以字符串命名的音频场景

desc [4/5]

const char* AudioSubPortCapability::desc

描述:

以字符串命名的子端口

desc [5/5]

const char* AudioDevExtInfo::desc

描述:

地址描述

device

struct AudioDevExtInfo AudioRouteNode::ext::device

描述:

设备特定信息。

deviceId

unsigned int AudioPortCapability::deviceId

描述:

绑定（bind）设备ID，唯一的设备识别符。

deviceType

unsigned int AudioPortCapability::deviceType

描述:

设备输出、输入类型。

dir

enum AudioPortDirection AudioPort::dir

描述:

音频端口的类型，详情参考AudioPortDirection。

format

enum AudioFormat AudioSampleAttributes::format

描述:

音频数据格式，详情参考AudioFormat。

formatNum

unsigned int AudioPortCapability::formatNum

描述:

支持的音频格式数目

formats

enum AudioFormat* AudioPortCapability::formats

描述:

支持的音频格式，详情参考AudioFormat。

frameSize

uint32_t AudioSampleAttributes::frameSize

描述:

音频数据的帧大小

hardwareMode

bool AudioPortCapability::hardwareMode

描述:

是否支持设备绑定处理

id

unsigned int AudioSceneDescriptor::SceneDesc::id

描述:

音频场景的ID

interleaved

bool AudioSampleAttributes::interleaved

描述:

音频数据交织的标记

isBigEndian

bool AudioSampleAttributes::isBigEndian

描述:

音频数据的大端标志

isShareable

int32_t AudioMmapBufferDescriptor::isShareable

描述:

mmap缓冲区是否可以在进程间共享

isSignedData

bool AudioSampleAttributes::isSignedData

描述:

音频数据的有符号或无符号标志

mask

enum AudioPortPassthroughMode AudioSubPortCapability::mask

描述:

数据透传模式，详情参考AudioPortPassthroughMode。

memoryAddress

void* AudioMmapBufferDescriptor::memoryAddress

描述:

指向mmap缓冲区的指针

memoryFd

int32_t AudioMmapBufferDescriptor::memoryFd

描述:

mmap缓冲区的文件描述符

mix

struct AudioMixExtInfo AudioRouteNode::ext::mix

描述:

音轨特定信息。

moduleId [1/2]

int32_t AudioDevExtInfo::moduleId

描述:

音频流绑定的模块ID

moduleId [2/2]

int32_t AudioMixExtInfo::moduleId

描述:

流所属模块标识符

period

uint32_t AudioSampleAttributes::period

描述:

音频采样周期

pins

enum AudioPortPin AudioDeviceDescriptor::pins

描述:

音频端口上的PIN脚（输出、输入），详情参考AudioPortPin。

portId [1/4]

unsigned int AudioPort::portId

描述:

音频端口的ID

portId [2/4]

unsigned int AudioDeviceDescriptor::portId

描述:

音频端口ID

portId [3/4]

unsigned int AudioSubPortCapability::portId

描述:

子端口ID

portId [4/4]

int32_t AudioRouteNode::portId

描述:

音频端口ID

portName

const char* AudioPort::portName

描述:

音频端口的名称

portNum

unsigned int AudioAdapterDescriptor::portNum

描述:

一个音频适配器支持的端口数目

ports

struct AudioPort* AudioAdapterDescriptor::ports

描述:

一个音频适配器支持的端口列表

role

enum AudioPortRole AudioRouteNode::role

描述:

指定端口角色为sink或source

sampleRate

unsigned int AudioSampleAttributes::sampleRate

描述:

音频采样频率

sampleRateMasks

unsigned int AudioPortCapability::sampleRateMasks

描述:

支持的音频采样频率（8k、16k、32k、48k）

scene

union AudioSceneDescriptor::SceneDesc AudioSceneDescriptor::scene

描述:

音频场景的名称

session

struct AudioSessionExtInfo AudioRouteNode::ext::session

描述:

会话特定信息。

sessionType

enum AudioSessionType AudioSessionExtInfo::sessionType

描述:

音频会话类型

silenceThreshold

uint32_t AudioSampleAttributes::silenceThreshold

描述:

音频捕获缓冲区阈值

sinks

const struct AudioRouteNode* AudioRoute::sinks

描述:

接受端列表

sinksNum

uint32_t AudioRoute::sinksNum

描述:

接受端节点数量

sources

const struct AudioRouteNode* AudioRoute::sources

描述:

发送端列表

sourcesNum

uint32_t AudioRoute::sourcesNum

描述:

发送端节点数量

startThreshold

uint32_t AudioSampleAttributes::startThreshold

描述:

音频渲染开始阈值

stopThreshold

uint32_t AudioSampleAttributes::stopThreshold

描述:

音频渲染停止阈值

streamId [1/2]

int32_t AudioSampleAttributes::streamId

描述:

渲染或捕获的音频标识符

streamId [2/2]

int32_t AudioMixExtInfo::streamId

描述:

由调用者传递的Render或Capture标识符

subPorts

struct AudioSubPortCapability* AudioPortCapability::subPorts

描述:

支持的子端口列表

subPortsNum

unsigned int AudioPortCapability::subPortsNum

描述:

支持的子端口数目（仅用于输出设备）

supportSampleFormatNum

uint32_t AudioPortCapability::supportSampleFormatNum

描述:

支持的音频样本格式数量

supportSampleFormats

enum AudioSampleFormat* AudioPortCapability::supportSampleFormats

描述:

支持的音频样本格式，详请参考AudioSampleFormat。

totalBufferFrames

int32_t AudioMmapBufferDescriptor::totalBufferFrames

描述:

缓冲区总大小，单位：帧。

transferFrameSize

int32_t AudioMmapBufferDescriptor::transferFrameSize

描述:

传输大小，单位：帧。

tvNSec

int64_t AudioTimeStamp::tvNSec

描述:

tvNSec时间，单位：纳秒。

tvSec

int64_t AudioTimeStamp::tvSec

描述:

tvSec时间，单位：秒。

type [1/3]

enum AudioCategory AudioSampleAttributes::type

描述:

音频类型，详情参考AudioCategory。

type [2/3]

enum AudioPortPin AudioDevExtInfo::type

描述:

音频端口上的PIN脚（输出、输入），详情参考AudioPortPin。

type [3/3]

enum AudioPortType AudioRouteNode::type

描述:

指定端口类型为device, mix等。