OSXBLUEVOICE: Inc/osx_bluevoice.h Source File

STM32 OSX BlueVoice

OSXBLUEVOICE
Documentation for OSXBLUEVOICE Library for STM32, BlueNRG and MP34DT01-M
osx_bluevoice.h
Go to the documentation of this file.
1 
39 /* Define to prevent recursive inclusion -------------------------------------*/
40 #ifndef __OSX_BLUEVOICE_H
41 #define __OSX_BLUEVOICE_H
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /* Includes ------------------------------------------------------------------*/
48 
49 #include "bluenrg_aci_const.h"
50 #include "bluenrg_gatt_aci.h"
51 
71 typedef enum
72 {
73  FR_8000 = 8000,
74  FR_16000 = 16000
87 typedef enum
88 {
89  OSX_BV_SUCCESS = 0x00,
91  OSX_BV_ERROR = 0x01,
102 } OSX_BV_Status;
114 typedef enum
115 {
116  NOT_READY = 0x00,
117  TRANSMITTER = 0x01,
118  RECEIVER = 0x02,
119  HALF_DUPLEX = 0x03
120 } OSX_BV_Mode;
132 typedef enum
133 {
140 
160 typedef struct
161 {
164  uint8_t channel_tot;
166  uint8_t channel_in;
180 typedef struct
181 {
182  uint8_t ServiceUUID[16];
184  uint8_t CharAudioUUID[16];
186  uint8_t CharAudioSyncUUID[16];
200 typedef struct
201 {
202  uint16_t ServiceHandle;
204  uint16_t CharAudioHandle;
209 
225 #define OSX_BLUEVOICE_TIMEOUT_STATUS ((uint16_t)500)
236 #define OSX_BLUEVOICE_PCM_SAMPLES_PER_PACKET (40)
255  OSX_BV_Status osx_BlueVoice_Initialize(void);
256 
263 
269  uint8_t osx_BlueVoice_IsProfileConfigured(void);
270 
277  OSX_BV_Status osx_BlueVoice_AddService(uint8_t *service_uuid, uint16_t *service_handle);
278 
287 
294 
301 
308 
315 
322 
329 
336  OSX_BV_Status osx_BlueVoice_AudioIn(uint16_t* buffer, uint8_t Nsamples);
337 
344  OSX_BV_Status osx_BlueVoice_SendData(uint16_t *NbyteSent);
345 
355  OSX_BV_Status osx_BlueVoice_ParseData(uint8_t* buffer_in, uint32_t Len, uint16_t attr_handle, uint8_t* buffer_out, uint8_t *samples);
356 
371 
378 
386  OSX_BV_Status osx_BlueVoice_AttributeModified_CB(uint16_t attr_handle, uint8_t attr_len, uint8_t *attr_value);
387 
392  int osx_BlueVoice_GetLibVersion(char *version);
393 
407 #ifdef __cplusplus
408 }
409 #endif
410 
411 #endif /* __OSX_BLUEVOICE_H */
412 
413 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Sampling_fr_t sampling_frequency
Definition: osx_bluevoice.h:162
uint16_t ServiceHandle
Definition: osx_bluevoice.h:202
Definition: osx_bluevoice.h:73
OSX_BV_Profile_Status osx_BlueVoice_GetStatus(void)
This function returns the BLUEVOICE Profile State Machine status.
Definition: osx_bluevoice.h:99
OSX_BV_Status osx_BlueVoice_SendData(uint16_t *NbyteSent)
This function must be called when the compressed audio data are ready, (when the function BLUEVOICE_A...
OSX_BV_Status osx_BlueVoice_IncTick(void)
This function increases the the internal counter, used to switch from Receiving/Streaming to Ready st...
BlueVoice profile configuration parameters.
Definition: osx_bluevoice.h:160
OSX_BV_Status osx_BlueVoice_ConnectionComplete_CB(uint16_t handle)
This function must be called when there is a LE Connection Complete event.
OSX_BV_Status osx_BlueVoice_AddChar(OSX_BLUEVOICE_uuid_t uuid, uint16_t service_handle, OSX_BLUEVOICE_ProfileHandle_t *handle)
This function is called to add BlueVoice characteristics.
OSX_BV_Status osx_BlueVoice_SetTxHandle(OSX_BLUEVOICE_ProfileHandle_t *tx_handle)
This function is called to set the handles if the BlueVoice characteristics are added out of the libr...
Definition: osx_bluevoice.h:90
OSX_BV_Status osx_BlueVoice_ParseData(uint8_t *buffer_in, uint32_t Len, uint16_t attr_handle, uint8_t *buffer_out, uint8_t *samples)
This function is called to parse received data.
Definition: osx_bluevoice.h:138
Definition: osx_bluevoice.h:96
Definition: osx_bluevoice.h:89
Definition: osx_bluevoice.h:93
OSX_BV_Status osx_BlueVoice_SetConfig(OSX_BLUEVOICE_Config_t *OSX_BLUEVOICE_Config)
This function is called to set the configuration parameters.
OSX_BV_Status osx_BlueVoice_SetRxHandle(OSX_BLUEVOICE_ProfileHandle_t *rx_handle)
This function is called to set the handles discovered, if an other BlueVoice module is available...
OSX_BV_Status
Return states values.
Definition: osx_bluevoice.h:87
OSX_BV_Mode osx_BlueVoice_GetMode(void)
This function returns the current modality.
Definition: osx_bluevoice.h:137
OSX_BV_Status osx_BlueVoice_EnableNotification(void)
This function is called to enable notifications mechanism.
uint8_t osx_BlueVoice_IsProfileConfigured(void)
This function returns if the BlueVoice Profile is configured.
Definition: osx_bluevoice.h:95
Definition: osx_bluevoice.h:116
OSX_BV_Status osx_BlueVoice_DisconnectionComplete_CB(void)
This function must be called when there is a LE disconnection Complete event.
Definition: osx_bluevoice.h:94
uint8_t channel_tot
Definition: osx_bluevoice.h:164
Definition: osx_bluevoice.h:100
OSX_BV_Mode
BlueVoice working modalities.
Definition: osx_bluevoice.h:114
Definition: osx_bluevoice.h:136
uint16_t CharAudioSyncHandle
Definition: osx_bluevoice.h:206
Definition: osx_bluevoice.h:92
Definition: osx_bluevoice.h:118
Definition: osx_bluevoice.h:101
OSX_BV_Profile_Status
BlueVoice profile status.
Definition: osx_bluevoice.h:132
uint16_t CharAudioHandle
Definition: osx_bluevoice.h:204
BlueVoice profile configuration parameters.
Definition: osx_bluevoice.h:200
Sampling_fr_t
Accepted audio in sampling frequencies.
Definition: osx_bluevoice.h:71
OSX_BV_Status osx_BlueVoice_AddService(uint8_t *service_uuid, uint16_t *service_handle)
This function is called to add BlueVoice Service.
Definition: osx_bluevoice.h:91
int osx_BlueVoice_GetLibVersion(char *version)
This function is called to get library version.
Definition: osx_bluevoice.h:98
BlueVoice profile configuration parameters.
Definition: osx_bluevoice.h:180
Definition: osx_bluevoice.h:117
uint8_t channel_in
Definition: osx_bluevoice.h:166
Definition: osx_bluevoice.h:119
Definition: osx_bluevoice.h:134
OSX_BV_Status osx_BlueVoice_AttributeModified_CB(uint16_t attr_handle, uint8_t attr_len, uint8_t *attr_value)
This function must be called when there is a LE attribut modified event.
Definition: osx_bluevoice.h:74
OSX_BV_Status osx_BlueVoice_AudioIn(uint16_t *buffer, uint8_t Nsamples)
This function is called to fill audio buffer.
Definition: osx_bluevoice.h:97
Definition: osx_bluevoice.h:135
Generated on Mon Aug 29 2016 15:19:56 for OSXBLUEVOICE by   doxygen 1.8.9.1