This section introduces the Bluetooth codec APIs including terms and acronyms, supported features, details on how to use the codec, function groups, enums, structures and functions. More...

Overview

This section introduces the Bluetooth codec APIs including terms and acronyms, supported features, details on how to use the codec, function groups, enums, structures and functions.

The Bluetooth codec is used for A2DP and HFP profiles.

Terms and acronyms

Terms	Details
A2DP	The Advanced Audio Distribution Profile (A2DP) defines the protocols and procedures that implement distribution of audio content of high-quality in mono or stereo on ACL channels.
HFP	The Hands-free Profile (HFP) defines the device acting as the audio gateway's remote audio input and output mechanism.
AAC	Advanced Audio Coding (AAC) is an audio coding standard for lossy digital audio compression.
SBC	The Low Complexity Subband Coding (SBC) is an audio subband codec specified by the Bluetooth Special Interest Group (SIG) for the Advanced Audio Distribution Profile (A2DP). SBC is a digital audio encoder and decoder used to transfer data to Bluetooth audio output devices like headphones or loudspeakers.
VBR	Variable bitrate (VBR) is a term used in telecommunications and computing that relates to the bitrate used in sound or video encoding.

How to use this module

The A2DP sink codec
- Open and close the A2DP sink codec using bt_codec_a2dp_open() and bt_codec_a2dp_close().
- The audio streaming data can be filled through a shared buffer (Method 1) or through a callback function (Method 2).
  - Sample code:
    bt_media_handle_t handle;
    void bt_audio_callback(bt_media_handle_t *handle, bt_codec_media_event_t event)
    {
    if (event == BT_CODEC_MEDIA_ERROR ) {
    // Error handling, such as notify the Bluetooth module or stop the A2DP codec.
    }
    }
    int32_t bt_sink_codec_get_data_callback(volatile uint16_t *buf, uint32_t len);
    void bt_audio_sink_sbc_open(void)
    {
    bt_codec_a2dp_audio_t sbc_sink_config;
    bt_codec_sbc_t sbc_codec_parameter;
    uint8_t* ring_buf = NULL;
    // Configure the SBC codec capability parameters.
    sbc_codec_parameter.min_bit_pool = 2;
    sbc_codec_parameter.max_bit_pool = 75;
    sbc_codec_parameter.block_length = 0xf;
    sbc_codec_parameter.subband_num = 0xf;
    sbc_codec_parameter.alloc_method = 0x3;
    sbc_codec_parameter.sample_rate = 0xf;
    sbc_codec_parameter.channel_mode = 0xf;
    sbc_sink_config.role = BT_A2DP_SINK;
    sbc_sink_config.codec_cap.type = BT_A2DP_CODEC_SBC;
    sbc_sink_config.codec_cap.codec.sbc = sbc_codec_parameter;
    // Open the A2DP codec.
    handle = bt_codec_a2dp_open(bt_audio_callback, &sbc_sink_config);
    if (handle == NULL) {
    // Error handling, failed to open the codec.
    }
    // Fill the audio streaming data through shared buffer (Method 1) or through callback function (Method 2).
    // Method 1: Set a shared buffer.
    // Apply a user-defined buffer to the codec with the ring buffer size (BT_RING_BUFFER_SIZE).
    ring_buf = (uint8_t *)malloc(BT_RING_BUFFER_SIZE);
    handle->set_buffer(handle, (uint8_t*)ring_buf, BT_RING_BUFFER_SIZE);
    // Method 2: Set callback function to get data.
    handle->set_get_data_function(handle,bt_sink_codec_get_data_callback);
    // Start the A2DP codec.
    handle->play(handle);
    }
    void bt_audio_sink_sbc_close(void)
    {
    handle->stop(handle);
    bt_codec_a2dp_close(handle);
    }
    // Fill the audio streaming data through a shared buffer (Method 1).
    void bt_a2dp_sink_fill_data(void)
    {
    uint32_t ring_buffer_free_space = 0, available_size = 0, data_length = 0;
    uint8_t *data_buffer = 0;
    // Data length and data management at Bluetooth driver itself.
    ring_buffer_free_space = handle->get_free_space(handle);
    // Get the current length of buffer to write the data.
    handle->get_write_buffer(handle, &data_buffer, &available_size);
    // Fill the buffer #data_buffer with a proper amount of data depending on ring_buffer_free_space, available_size and data_length.
    handle->write_data_done(handle, data_length);
    }
    // Fill the audio streaming data using a callback function (Method 2).
    int32_t bt_sink_codec_get_data_callback(volatile uint16_t *buf, uint32_t len)
    {
    // The user can fill audio streaming data into buf. The length of audio streaming data must be less than or equal to len.
    }
The HFP codec
- Open and close the HFP codec using bt_codec_hfp_open() and bt_codec_hfp_close().
  - Sample code:
    bt_media_handle_t handle;
    void bt_audio_codec_hfp_callback(bt_media_handle_t *handle, bt_codec_media_event_t event)
    {
    if (event == BT_CODEC_MEDIA_ERROR ) {
    // Error handling, such as notify the Bluetooth module or stop the HFP codec.
    }
    }
    void bt_audio_codec_hfp_start(void)
    {
    bt_codec_hfp_audio_t hfp_config;
    bt_codec_media_status_t status;
    hfp_config.type = BT_HFP_CODEC_TYPE_CVSD;
    // Open the HFP codec.
    handle = bt_codec_hfp_open(bt_audio_codec_hfp_callback, &hfp_config);
    if (handle == NULL) {
    // Error handling, failed to open the codec.
    }
    // Start the HFP codec.
    status = handle->play(handle);
    if (status != BT_CODEC_MEDIA_STATUS_MEDIA_OK) {
    // Error handling, failed to play the media.
    }
    }
    void bt_audio_codec_hfp_stop(void)
    {
    bt_codec_media_status_t status;
    status = handle->stop(handle);
    if (status != BT_CODEC_MEDIA_STATUS_MEDIA_OK) {
    // Error handling, failed to stop the codec.
    }
    status = bt_codec_hfp_close(handle);
    if (status != BT_CODEC_MEDIA_STATUS_MEDIA_OK) {
    // Error handling, failed to close the codec.
    }
    }

Functions
bt_media_handle_t *	bt_codec_a2dp_open (bt_codec_a2dp_callback_t callback, const bt_codec_a2dp_audio_t *param)
	This function opens the A2DP audio codec. More...

bt_codec_media_status_t	bt_codec_a2dp_close (bt_media_handle_t *handle)
	This function closes the A2DP audio codec. More...

bt_codec_media_status_t	bt_codec_hfp_mix_stream_out (bt_codec_media_hfp_mix_stream_out_method_t mix_method, void *buffer, uint32_t sample_count)
	This function mixes a tone to the stream out tone. More...

bt_codec_media_status_t	bt_codec_hfp_get_mix_stream_out_sample_count (uint32_t *sample_count)
	This function queries the sample_count of mix stream out buffer. More...

bt_codec_media_status_t	bt_codec_hfp_unregister_mix_stream_out_data_callback (void)
	This function unregisters the callback function for mix stream out data. More...

bt_codec_media_status_t	bt_codec_hfp_register_mix_stream_out_data_callback (bt_codec_hfp_mix_stream_out_data_callback_t callback, void *user_data)
	This function registers a callback function for mixing stream out data. More...

bt_codec_media_status_t	bt_codec_hfp_read_stream_in (void *buffer, uint32_t sample_count)
	This function receives the streamed in data. More...

bt_codec_media_status_t	bt_codec_hfp_get_stream_in_sample_count (uint32_t *sample_count)
	This function queries the sample_count of the streamed in buffer. More...

bt_codec_media_status_t	bt_codec_hfp_unregister_get_stream_in_data_callback (void)
	This function unregisters the callback function that receives streamed in data. More...

bt_codec_media_status_t	bt_codec_hfp_register_get_stream_in_data_callback (bt_codec_hfp_get_stream_in_data_callback_t callback, void *user_data)
	This function registers the callback function that receives streamed in data. More...

bt_codec_media_status_t	bt_codec_hfp_read_stream_out (void *buffer, uint32_t sample_count)
	Recieve data from stream in. More...

bt_codec_media_status_t	bt_codec_hfp_get_stream_out_sample_count (uint32_t *sample_count)
	Query the sample_count of stream in buffer. More...

bt_codec_media_status_t	bt_codec_hfp_unregister_get_stream_out_data_callback (void)
	Unregister the callback function for getting stream out data. More...

bt_codec_media_status_t	bt_codec_hfp_register_get_stream_out_data_callback (bt_codec_hfp_get_stream_out_data_callback_t callback, void *user_data)
	Register the callback function for get stream out data. More...

bt_codec_media_status_t	bt_codec_hfp_set_customer_enhanced_stream_in_data (void *buffer, uint32_t sample_count)
	set enhanced stream in data stream in. More...

bt_codec_media_status_t	bt_codec_hfp_get_customer_enhanced_stream_in_sample_count (uint32_t *sample_count)
	Query the sample count of enhanced stream in buffer that customer need feedback. More...

bt_codec_media_status_t	bt_codec_hfp_unregister_customer_enhancement_function_callback (void)
	Unregister customer enhancement callback function. More...

bt_codec_media_status_t	bt_codec_hfp_register_customer_enhancement_function_callback (bt_codec_hfp_customer_enhancement_function_callback_t callback, void *user_data)
	Register customer enhancement function. More...

bt_codec_media_status_t	bt_codec_hfp_set_device_path (bt_codec_hfp_device_path_t device_path)
	This function sets the HFP device path. More...

bt_media_handle_t *	bt_codec_hfp_open (bt_codec_hfp_callback_t callback, const bt_codec_hfp_audio_t *param)
	This function opens the HFP audio codec. More...

bt_codec_media_status_t	bt_codec_hfp_close (bt_media_handle_t *handle)
	This function closes the HFP codec. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_set_flag (bt_media_handle_t *handle, bool flag)
	This function sets the advanced wireless stereo flag. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_set_initial_sync (bt_media_handle_t *handle)
	This function sets the advanced wireless stereo initial synchronization. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_get_consumed_data_count (bt_media_handle_t handle, bt_codec_a2dp_data_count_t information)
	This function gets the advanced wireless stereo consumed data count. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_get_silence_frame_information (bt_media_handle_t handle, bt_codec_a2dp_bitstream_t information)
	This function gets the advanced wireless stereo silence frame information for one silence frame. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_fill_silence_frame (bt_media_handle_t handle, bt_codec_a2dp_buffer_t data, uint32_t frame_count)
	This function fills the advanced wireless stereo silence frames to target data buffer. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_parse_data_information (bt_media_handle_t handle, bt_codec_a2dp_buffer_t data, bt_codec_a2dp_bitstream_t *information)
	This function parses the advanced wireless stereo packet data information. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_get_clock_skew_status (bt_media_handle_t handle, bt_codec_aws_clock_skew_status_t status)
	This function gets the advanced wireless stereo clock skew status. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_set_clock_skew_compensation_value (bt_media_handle_t *handle, int32_t sample_count)
	This function sets the advanced wireless stereo clock skew compensation value. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_get_audio_latency (bt_media_handle_t handle, uint32_t sampling_rate, uint32_t latency_us)
	This function gets the advanced wireless stereo audio latency. More...

bt_codec_media_status_t	bt_codec_a2dp_set_sw_aac_flag (bool flag)
	This function sets the software AAC DECODER for Bluetooth A2DP. More...

bool	bt_codec_a2dp_get_sw_aac_flag (void)
	This function gets the software AAC DECODER for Bluetooth A2DP. More...

bt_codec_media_status_t	bt_codec_a2dp_aws_set_clock_skew (bool flag)
	This function sets the clock skew flag. More...

Modules
	Define

	Enum

	Struct

Function Documentation

bt_codec_media_status_t bt_codec_a2dp_aws_fill_silence_frame	(	bt_media_handle_t *	handle,
		bt_codec_a2dp_buffer_t *	data,
		uint32_t	frame_count
	)

This function fills the advanced wireless stereo silence frames to target data buffer.

Parameters

[in]	handle	is the A2DP codec handle.
[out]	data	points to the target data buffer structure.
[in]	frame_count	is the silence frame count.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_get_audio_latency	(	bt_media_handle_t *	handle,
		uint32_t	sampling_rate,
		uint32_t *	latency_us
	)

This function gets the advanced wireless stereo audio latency.

Parameters

[in]	handle	is the A2DP codec handle.
[in]	sampling_rate	is the audio sampling rate in Hz.
[out]	latency_us	points to the audio latency in microsecond.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_get_clock_skew_status	(	bt_media_handle_t *	handle,
		bt_codec_aws_clock_skew_status_t *	status
	)

This function gets the advanced wireless stereo clock skew status.

Parameters

[in]	handle	is the A2DP codec handle.
[out]	status	points to the clock skew status.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_get_consumed_data_count	(	bt_media_handle_t *	handle,
		bt_codec_a2dp_data_count_t *	information
	)

This function gets the advanced wireless stereo consumed data count.

Parameters

[in]	handle	is the A2DP codec handle.
[out]	information	points to the consumed data count information.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_get_silence_frame_information	(	bt_media_handle_t *	handle,
		bt_codec_a2dp_bitstream_t *	information
	)

This function gets the advanced wireless stereo silence frame information for one silence frame.

Parameters

[in]	handle	is the A2DP codec handle.
[out]	information	points to the silence frame information for one silence frame.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_parse_data_information	(	bt_media_handle_t *	handle,
		bt_codec_a2dp_buffer_t *	data,
		bt_codec_a2dp_bitstream_t *	information
	)

This function parses the advanced wireless stereo packet data information.

Parameters

[in]	handle	is the A2DP codec handle.
[in]	data	points to the packet data buffer structure.
[out]	information	points to the packet data buffer information.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_set_clock_skew ( bool flag )

This function sets the clock skew flag.

Parameters

[in] flag is used to turn on or turn off clock skew. 1: turn on clock skew, 0: turn off clock skew.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_set_clock_skew_compensation_value	(	bt_media_handle_t *	handle,
		int32_t	sample_count
	)

This function sets the advanced wireless stereo clock skew compensation value.

Parameters

[in]	handle	is the A2DP codec handle.
[in]	sample_count	is the audio sample count to be compensated. One pair of L / R counts as one audio sample.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_set_flag	(	bt_media_handle_t *	handle,
		bool	flag
	)

This function sets the advanced wireless stereo flag.

Parameters

[in]	handle	is the A2DP codec handle.
[in]	flag	is used to determine to turn on or turn off AWS mechanism. 1: turn on AWS, 0: turn off AWS.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_aws_set_initial_sync ( bt_media_handle_t * handle )

This function sets the advanced wireless stereo initial synchronization.

Parameters

[in] handle is the A2DP codec handle.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_a2dp_close ( bt_media_handle_t * handle )

This function closes the A2DP audio codec.

Parameters

[in] handle is the A2DP codec handle.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bool bt_codec_a2dp_get_sw_aac_flag ( void )

This function gets the software AAC DECODER for Bluetooth A2DP.

Returns: If the software AAC DECODER is enabled, the return value is #true, otherwise the return value is #false.

bt_media_handle_t* bt_codec_a2dp_open	(	bt_codec_a2dp_callback_t	callback,
		const bt_codec_a2dp_audio_t *	param
	)

This function opens the A2DP audio codec.

Parameters

[in]	callback	is a pointer to the callback function for the A2DP data control.
[in]	param	is the settings of the A2DP codec.

Returns: Media handle of the A2DP. Please refer to bt_media_handle_t.

bt_codec_media_status_t bt_codec_a2dp_set_sw_aac_flag ( bool flag )

This function sets the software AAC DECODER for Bluetooth A2DP.

Parameters

[in] flag is used to determine whether the software AAC DECODER mechanism is turned on. true: Decode AAC by Cortex-M4, false: Decode AAC by DSP.

Returns: If the operation completed successfully, the return value is BT_CODEC_MEDIA_STATUS_OK, otherwise the return value is BT_CODEC_MEDIA_STATUS_ERROR.

bt_codec_media_status_t bt_codec_hfp_close ( bt_media_handle_t * handle )

This function closes the HFP codec.

Parameters

[in] handle is the HFP codec handle.

Returns: BT_CODEC_MEDIA_STATUS_OK, if the operation completed successfully, BT_CODEC_MEDIA_STATUS_ERROR, if an error occurred.

bt_codec_media_status_t bt_codec_hfp_get_customer_enhanced_stream_in_sample_count ( uint32_t * sample_count )

Query the sample count of enhanced stream in buffer that customer need feedback.

Parameters

[out] sample_count is the size of enhanced stream in buffer (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

Note: Call this function before bt_codec_hfp_set_customer_enhanced_stream_in_data() to know the maximum stream in buffer.

See also: bt_codec_hfp_set_customer_enhanced_stream_in_data()

bt_codec_media_status_t bt_codec_hfp_get_mix_stream_out_sample_count ( uint32_t * sample_count )

This function queries the sample_count of mix stream out buffer.

Parameters

[out] sample_count is the size of the mix stream out buffer (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

Note: Call this function before bt_codec_hfp_mix_stream_out() to find the maximum mix stream out buffer size.

See also: bt_codec_hfp_mix_stream_out()

bt_codec_media_status_t bt_codec_hfp_get_stream_in_sample_count ( uint32_t * sample_count )

This function queries the sample_count of the streamed in buffer.

Parameters

[out] sample_count is the size of stream in buffer (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

Note: Call this function before bt_codec_hfp_read_stream_in() to know the maximum stream in buffer size.

See also: bt_codec_hfp_read_stream_in()

bt_codec_media_status_t bt_codec_hfp_get_stream_out_sample_count ( uint32_t * sample_count )

Query the sample_count of stream in buffer.

Parameters

[out] sample_count is the size of stream in buffer (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

Note: Call this function before bt_codec_hfp_read_stream_in() to know the maximum stream in buffer.

See also: bt_codec_hfp_read_stream_in()

bt_codec_media_status_t bt_codec_hfp_mix_stream_out	(	bt_codec_media_hfp_mix_stream_out_method_t	mix_method,
		void *	buffer,
		uint32_t	sample_count
	)

This function mixes a tone to the stream out tone.

Parameters

[in]	mix_method	is to indicate which mix method will be used.
[in]	*buffer	is the tone buffer that will mix with stream out tone.
[in]	sample_count	is the size of *buffer that will mix with stream out tone (in bytes). It will equal or less than the sample_count that get from bt_codec_hfp_get_mix_stream_out_sample_count().

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

See also: bt_codec_hfp_get_mix_stream_out_sample_count()

bt_media_handle_t* bt_codec_hfp_open	(	bt_codec_hfp_callback_t	callback,
		const bt_codec_hfp_audio_t *	param
	)

This function opens the HFP audio codec.

Parameters

[in]	callback	is a pointer to the callback function for HFP error handling.
[in]	param	is the HFP codec settings.

Returns: Media handle of the HFP.

bt_codec_media_status_t bt_codec_hfp_read_stream_in	(	void *	buffer,
		uint32_t	sample_count
	)

This function receives the streamed in data.

Parameters

[in]	buffer	is a pointer to a user defined buffer.
[in]	sample_count	is the amount of data received (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if if the operation completed successfully.

See also: bt_codec_hfp_get_stream_in_sample_count()

bt_codec_media_status_t bt_codec_hfp_read_stream_out	(	void *	buffer,
		uint32_t	sample_count
	)

Recieve data from stream in.

Parameters

[in]	buffer	is a pointer to a user defined buffer.
[in]	sample_count	is the amount of data received (in bytes).

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

See also: bt_codec_hfp_get_stream_in_sample_count()

bt_codec_media_status_t bt_codec_hfp_register_customer_enhancement_function_callback	(	bt_codec_hfp_customer_enhancement_function_callback_t	callback,
		void *	user_data
	)

Register customer enhancement function.

Parameters

[in]	callback	is the function pointer of customer enhancement function.
[in]	user_data	is extended parameter for user.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

bt_codec_media_status_t bt_codec_hfp_register_get_stream_in_data_callback	(	bt_codec_hfp_get_stream_in_data_callback_t	callback,
		void *	user_data
	)

This function registers the callback function that receives streamed in data.

Parameters

[in]	callback	is a pointer to the callback function that receives the streamed in data.
[in]	user_data	is a user defined parameter, user can use it if necessary.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

bt_codec_media_status_t bt_codec_hfp_register_get_stream_out_data_callback	(	bt_codec_hfp_get_stream_out_data_callback_t	callback,
		void *	user_data
	)

Register the callback function for get stream out data.

Parameters

[in]	callback	is the function pointer of callback for getting stream out data.
[in]	user_data	is extended parameter for user.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

bt_codec_media_status_t bt_codec_hfp_register_mix_stream_out_data_callback	(	bt_codec_hfp_mix_stream_out_data_callback_t	callback,
		void *	user_data
	)

This function registers a callback function for mixing stream out data.

Parameters

[in]	callback	is the function pointer of callback for mix stream out data control.
[in]	user_data	is a user defined parameter, user can use it if necessary.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

bt_codec_media_status_t bt_codec_hfp_set_customer_enhanced_stream_in_data	(	void *	buffer,
		uint32_t	sample_count
	)

set enhanced stream in data stream in.

Parameters

[in]	buffer	is a pointer to a user defined buffer.
[in]	sample_count	is the amount of enhanced data (in bytes). It will equal or less than the sample_count that get from bt_codec_hfp_get_customer_enhanced_stream_in_sample_count().

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

See also: bt_codec_hfp_get_customer_enhanced_stream_in_sample_count()

bt_codec_media_status_t bt_codec_hfp_set_device_path ( bt_codec_hfp_device_path_t device_path )

This function sets the HFP device path.

Parameters

[in] device_path is the HFP device path.

Returns: If the operation completed successfully, the return value is #BT_CODEC_MEDIA_STATUS_MEDIA_OK, otherwise the return value is #BT_CODEC_MEDIA_STATUS_MEDIA_ERROR.

bt_codec_media_status_t bt_codec_hfp_unregister_customer_enhancement_function_callback ( void )

Unregister customer enhancement callback function.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

bt_codec_media_status_t bt_codec_hfp_unregister_get_stream_in_data_callback ( void )

This function unregisters the callback function that receives streamed in data.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

bt_codec_media_status_t bt_codec_hfp_unregister_get_stream_out_data_callback ( void )

Unregister the callback function for getting stream out data.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if OK.

bt_codec_media_status_t bt_codec_hfp_unregister_mix_stream_out_data_callback ( void )

This function unregisters the callback function for mix stream out data.

Returns: #BT_CODEC_MEDIA_STATUS_MEDIA_OK, if the operation completed successfully.

Overview

Terms and acronyms

How to use this module

Functions

Modules

Function Documentation