Audio frame management module.

Functions for managing audio frames. More...

Data Structures
struct	m_audio_frame_t
	Compressed audio frame representation. More...

Functions
m_audio_frame_t *	m_audio_frame_get (m_audio_frame_t *p_frame)
	Function for getting an audio frame. More...
ret_code_t	m_audio_frame_init (void)
	Function for initializing the audio frame management module. More...
uint8_t	m_audio_frame_pool_current_utilization_get (void)
	Function for getting current utilization statistics. More...
uint8_t	m_audio_frame_pool_max_utilization_get (void)
	Function for getting maximum utilization statistics. More...
void	m_audio_frame_put (m_audio_frame_t *p_frame)
	Function for putting an audio frame. More...

Detailed Description

Functions for managing audio frames.

Function Documentation

m_audio_frame_t* m_audio_frame_get

(

m_audio_frame_t *

p_frame

)

Function for getting an audio frame.

If an argument is given, the same frame is returned and only the reference count is increased. \ If the argument is NULL, a new frame is allocated and the reference count is set to 1.

Parameters

[in]

p_frame

Pointer to an audio frame or NULL.

Returns

Pointer to an audio frame or NULL if allocation failed.

ret_code_t m_audio_frame_init

(

void

)

Function for initializing the audio frame management module.

Returns

NRF_SUCCESS on success, otherwise error code.

uint8_t m_audio_frame_pool_current_utilization_get

(

void

)

Function for getting current utilization statistics.

Returns

Current utilization [entries].

uint8_t m_audio_frame_pool_max_utilization_get

(

void

)

Function for getting maximum utilization statistics.

Returns

Maximum utilization [entries].

void m_audio_frame_put

(

m_audio_frame_t *

p_frame

)

Function for putting an audio frame.

Reference count of the given audio frame is decreased. If the reference count reaches 0, the frame is freed.

Parameters

[in]

p_frame

Pointer to an audio frame.