CI130X SDK API手册  2.2.0
本手册用于描述CI130X SDK各个组件和驱动API
枚举 | 函数
audio_play_api.h 文件参考

播放器接口函数 更多...

#include "audio_play_process.h"
#include "audio_play_config.h"
#include "audio_play_os_port.h"
#include "sdk_default_config.h"

浏览源代码.

枚举

enum  {
  AUDIO_PLAY_CB_STATE_UNKNOWN_ERR = -99,
  AUDIO_PLAY_CB_STATE_DECODER_MEM_ERR = -5,
  AUDIO_PLAY_CB_STATE_PARSE_MP3_MEM_ERR = -4,
  AUDIO_PLAY_CB_STATE_PARSE_M4A_MEM_ERR = -3,
  AUDIO_PLAY_CB_STATE_PARSE_FILE_LEASTDATA_ERR = -2,
  AUDIO_PLAY_CB_STATE_INTERNAL_ERR = -1,
  AUDIO_PLAY_CB_STATE_DONE = 0,
  AUDIO_PLAY_CB_STATE_PAUSE = 1,
  AUDIO_PLAY_CB_STATE_PAUSE_BEFORE_THRESHOLD = 2,
  AUDIO_PLAY_CB_STATE_PAUSE_AFTER_THRESHOLD = 3,
  AUDIO_PLAY_CB_STATE_PLAY_THRESHOLD = 4
}
 

函数

int32_t get_audio_play_version (char version[3])
 获取播放器组件版本号 更多...
 
int32_t play_prompt (uint32_t data_addr, uint32_t data_addr_num, CALLBACK_END_PLAY end_paly_callback)
 播放ADPCM 更多...
 
void pause_audio_play_prompt (uint32_t data_addr, uint32_t data_addr_num, CALLBACK_END_PLAY end_paly_callback)
 暂停当前的audio播放adpcm 更多...
 
int32_t stop_play (CALLBACK_END_PLAY end_paly_callback, void *xHigherPriorityTaskWoken)
 停止播放 更多...
 
int32_t pause_play (CALLBACK_END_PLAY end_paly_callback, void *xHigherPriorityTaskWoken)
 暂停播放 更多...
 
int32_t play_audio (const char *dir_or_url, const char *name, int offset, const char *decoder_name, CALLBACK_END_PLAY end_paly_callback)
 从sd卡或网络播放音乐 更多...
 
void pause_audio_play_audio (const char *dir, const char *name, int offset, const char *decoder_name, CALLBACK_END_PLAY end_paly_callback)
 暂停当前的audio播放新的audio 更多...
 
int32_t continue_history_play (CALLBACK_END_PLAY end_paly_callback)
 播放最近一次被打断的mp3 更多...
 
uint32_t get_play_offset (void)
 获取当前的播放进度, 更多...
 
uint32_t get_data_load_offset (void)
 获取读入数据缓冲器进度, 更多...
 
void audio_play_set_vol_gain (int32_t gain)
 调节播放音量 更多...
 
int32_t audio_play_get_vol_gain (void)
 获取当前播放音量 更多...
 
void audio_play_set_mute (bool is_mute)
 设置静音 更多...
 
void audio_play_hw_pa_da_ctl (FunctionalState cmd, bool is_control_pa)
 pa、da控制,可选择是否控制功放 更多...
 
void set_play_speed (float play_speed)
 设置播放倍速 更多...
 

详细描述

播放器接口函数

版本
1.0
日期
2019-04-02

枚举类型说明

◆ anonymous enum

anonymous enum
枚举值
AUDIO_PLAY_CB_STATE_UNKNOWN_ERR 
AUDIO_PLAY_CB_STATE_DECODER_MEM_ERR 
AUDIO_PLAY_CB_STATE_PARSE_MP3_MEM_ERR 
AUDIO_PLAY_CB_STATE_PARSE_M4A_MEM_ERR 
AUDIO_PLAY_CB_STATE_PARSE_FILE_LEASTDATA_ERR 
AUDIO_PLAY_CB_STATE_INTERNAL_ERR 
AUDIO_PLAY_CB_STATE_DONE 
AUDIO_PLAY_CB_STATE_PAUSE 
AUDIO_PLAY_CB_STATE_PAUSE_BEFORE_THRESHOLD 
AUDIO_PLAY_CB_STATE_PAUSE_AFTER_THRESHOLD 
AUDIO_PLAY_CB_STATE_PLAY_THRESHOLD 

函数说明

◆ audio_play_get_vol_gain()

int32_t audio_play_get_vol_gain ( void  )

获取当前播放音量

返回
int32_t 音量(0–100)

◆ audio_play_hw_pa_da_ctl()

void audio_play_hw_pa_da_ctl ( FunctionalState  cmd,
bool  is_control_pa 
)

pa、da控制,可选择是否控制功放

参数
cmdpa使能或失能

< 输入
< 输出

◆ audio_play_set_mute()

void audio_play_set_mute ( bool  is_mute)

设置静音

参数
is_mute是否静音

◆ audio_play_set_vol_gain()

void audio_play_set_vol_gain ( int32_t  gain)

调节播放音量

参数
gain音量(0–100)

◆ continue_history_play()

int32_t continue_history_play ( CALLBACK_END_PLAY  end_paly_callback)

播放最近一次被打断的mp3

参数
end_paly_callback结束播放回调函数指针
返回值
RETURN_OK播放启动成功
RETURN_ERR播放启动失败

◆ get_audio_play_version()

int32_t get_audio_play_version ( char  version[3])

获取播放器组件版本号

参数
version版本号buf,3byte
返回值
RETURN_OK获取成功
RETURN_ERR获取失败

◆ get_data_load_offset()

uint32_t get_data_load_offset ( void  )

获取读入数据缓冲器进度,

注解
在stop后仍可以获取最近一次播放结束位置,重新start会从0重新计算
返回
uint32_t 当前数据加载进度偏移

◆ get_play_offset()

uint32_t get_play_offset ( void  )

获取当前的播放进度,

注解
在stop后仍可以获取最近一次播放结束位置,重新start会从0重新计算
返回
uint32_t 当前播放进度偏移

◆ pause_audio_play_audio()

void pause_audio_play_audio ( const char *  dir,
const char *  name,
int  offset,
const char *  decoder_name,
CALLBACK_END_PLAY  end_paly_callback 
)

暂停当前的audio播放新的audio

注解
目前仅能记录历史mp3暂停状态1条,如需增加需扩展g_wave_total_lens和get_play_data.c中data_list
参数
dir文件路径
name文件名
offset播放偏移
decoder_name解码器名称
end_paly_callback结束播放回调函数指针

◆ pause_audio_play_prompt()

void pause_audio_play_prompt ( uint32_t  data_addr,
uint32_t  data_addr_num,
CALLBACK_END_PLAY  end_paly_callback 
)

暂停当前的audio播放adpcm

参数
data_addr播报词在flash内地址
end_paly_callback结束播放回调函数指针

◆ pause_play()

int32_t pause_play ( CALLBACK_END_PLAY  end_paly_callback,
void *  xHigherPriorityTaskWoken 
)

暂停播放

参数
end_paly_callback结束播放回调函数指针
返回值
RETURN_OK暂停成功
RETURN_ERR暂停失败(可能已经停止或未进行播放)

◆ play_audio()

int32_t play_audio ( const char *  dir_or_url,
const char *  name,
int  offset,
const char *  decoder_name,
CALLBACK_END_PLAY  end_paly_callback 
)

从sd卡或网络播放音乐

注解
可以指定解码器或不指定解码器,如果不指定解码器音频且文件头不是标准头会因找不到解码器而无法播放
参数
dir_or_url播放路径
name文件名称
offset播放偏移
decoder_name解码器名称
end_paly_callback结束播放回调函数指针
返回值
RETURN_OK播放启动成功
RETURN_ERR播放启动失败

◆ play_prompt()

int32_t play_prompt ( uint32_t  data_addr,
uint32_t  data_addr_num,
CALLBACK_END_PLAY  end_paly_callback 
)

播放ADPCM

参数
data_addr播报词在flash内地址
end_paly_callback结束播放回调函数指针
返回值
RETURN_OK播放启动成功
RETURN_ERR播放启动失败

◆ set_play_speed()

void set_play_speed ( float  play_speed)

设置播放倍速

参数
play_speed浮点型,1.0为无倍速,2.0为加速为2倍速,0.5为减速为1/2倍速

◆ stop_play()

int32_t stop_play ( CALLBACK_END_PLAY  end_paly_callback,
void *  xHigherPriorityTaskWoken 
)

停止播放

参数
end_paly_callback结束播放回调函数指针
返回值
RETURN_OK停止成功
RETURN_ERR停止失败(可能已经停止或未进行播放)