|
OSXBLUEVOICE
Documentation for OSXBLUEVOICE Library for STM32, BlueNRG and MP34DT01-M
|
osx_bluevoice.h File Reference
This file contains definitions for BlueVoice profile. More...
#include "bluenrg_aci_const.h"
#include "bluenrg_gatt_aci.h"Go to the source code of this file.
Classes | |
| struct | OSX_BLUEVOICE_Config_t |
| BlueVoice profile configuration parameters. More... | |
| struct | OSX_BLUEVOICE_uuid_t |
| BlueVoice profile configuration parameters. More... | |
| struct | OSX_BLUEVOICE_ProfileHandle_t |
| BlueVoice profile configuration parameters. More... | |
Macros | |
| #define | OSX_BLUEVOICE_TIMEOUT_STATUS ((uint16_t)500) |
| #define | OSX_BLUEVOICE_PCM_SAMPLES_PER_PACKET (40) |
Enumerations | |
| enum | Sampling_fr_t { FR_8000 = 8000, FR_16000 = 16000 } |
| Accepted audio in sampling frequencies. More... | |
| enum | OSX_BV_Status { OSX_BV_SUCCESS = 0x00, OSX_BV_LOCKER_ERROR = 0x11, OSX_BV_ERROR = 0x01, OSX_BV_DISCONNETED = 0x10, OSX_BV_NOT_CONFIG = 0x20, OSX_BV_RECEIVER_DISABLE = 0x30, OSX_BV_TRANSMITTER_DISABLE = 0x31, OSX_BV_RX_HANDLE_NOT_AVAILABLE = 0x32, OSX_BV_OUT_BUF_READY = 0x40, OSX_BV_OUT_BUF_NOT_READY = 0x41, OSX_BV_PCM_SAMPLES_ERR = 0x50, OSX_BV_NOTIF_DISABLE = 0x60, OSX_BV_TIMEOUT = 0x70 } |
| Return states values. More... | |
| enum | OSX_BV_Mode { NOT_READY = 0x00, TRANSMITTER = 0x01, RECEIVER = 0x02, HALF_DUPLEX = 0x03 } |
| BlueVoice working modalities. More... | |
| enum | OSX_BV_Profile_Status { OSX_BLUEVOICE_STATUS_UNITIALIZED = 0x00, OSX_BLUEVOICE_STATUS_INITIALIZED = 0x10, OSX_BLUEVOICE_STATUS_READY = 0x20, OSX_BLUEVOICE_STATUS_STREAMING = 0x30, OSX_BLUEVOICE_STATUS_RECEIVING = 0x40 } |
| BlueVoice profile status. More... | |
Functions | |
| OSX_BV_Status | osx_BlueVoice_Initialize (void) |
| This function is called to initialize the bluevoice library. More... | |
| OSX_BV_Status | osx_BlueVoice_SetConfig (OSX_BLUEVOICE_Config_t *OSX_BLUEVOICE_Config) |
| This function is called to set the configuration parameters. More... | |
| uint8_t | osx_BlueVoice_IsProfileConfigured (void) |
| This function returns if the BlueVoice Profile is configured. More... | |
| OSX_BV_Status | osx_BlueVoice_AddService (uint8_t *service_uuid, uint16_t *service_handle) |
| This function is called to add BlueVoice Service. More... | |
| 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. More... | |
| 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 library. More... | |
| 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. More... | |
| OSX_BV_Profile_Status | osx_BlueVoice_GetStatus (void) |
| This function returns the BLUEVOICE Profile State Machine status. More... | |
| OSX_BV_Mode | osx_BlueVoice_GetMode (void) |
| This function returns the current modality. More... | |
| OSX_BV_Status | osx_BlueVoice_IncTick (void) |
| This function increases the the internal counter, used to switch from Receiving/Streaming to Ready status. More... | |
| OSX_BV_Status | osx_BlueVoice_EnableNotification (void) |
| This function is called to enable notifications mechanism. More... | |
| OSX_BV_Status | osx_BlueVoice_AudioIn (uint16_t *buffer, uint8_t Nsamples) |
| This function is called to fill audio buffer. More... | |
| 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_AudioIn returns OSX_BV_OUT_BUF_READY) More... | |
| 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. More... | |
| OSX_BV_Status | osx_BlueVoice_ConnectionComplete_CB (uint16_t handle) |
| This function must be called when there is a LE Connection Complete event. More... | |
| OSX_BV_Status | osx_BlueVoice_DisconnectionComplete_CB (void) |
| This function must be called when there is a LE disconnection Complete event. More... | |
| 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. More... | |
| int | osx_BlueVoice_GetLibVersion (char *version) |
| This function is called to get library version. More... | |
Detailed Description
This file contains definitions for BlueVoice profile.
- Author
- Central Labs
- Version
- V2.0.0
- Date
- 4-July-2016
- Attention
© COPYRIGHT(c) 2015 STMicroelectronics
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Generated on Mon Aug 29 2016 15:19:56 for OSXBLUEVOICE by
1.8.9.1