PCM manipulation functions. More...

Collaboration diagram for PCM manipulation:

Typedefs
typedef struct _nugu_pcm	NuguPcm
	pcm object

Functions
NUGU_API int	nugu_pcm_add (NuguPcm *pcm)
	Add pcm object to managed list. More...

NUGU_API void	nugu_pcm_clear_buffer (NuguPcm *pcm)
	Clear pcm buffer. More...

NUGU_API void	nugu_pcm_emit_event (NuguPcm *pcm, enum nugu_media_event event)
	Emit event to registered callback. More...

NUGU_API void	nugu_pcm_emit_status (NuguPcm *pcm, enum nugu_media_status status)
	Emit status to registered callback. More...

NUGU_API NuguPcm *	nugu_pcm_find (const char *name)
	Find a pcm object by name in the managed list. More...

NUGU_API void	nugu_pcm_free (NuguPcm *pcm)
	Destroy the pcm object. More...

NUGU_API int	nugu_pcm_get_audio_attribute (NuguPcm *pcm)
	Get audio attribute. More...

NUGU_API const char *	nugu_pcm_get_audio_attribute_str (NuguPcm *pcm)
	Get audio attribute. More...

NUGU_API int	nugu_pcm_get_data (NuguPcm pcm, char data, size_t size)
	Get all data. More...

NUGU_API size_t	nugu_pcm_get_data_size (NuguPcm *pcm)
	Get pcm data size. More...

NUGU_API void *	nugu_pcm_get_driver_data (NuguPcm *pcm)
	Get custom data for driver. More...

NUGU_API int	nugu_pcm_get_duration (NuguPcm *pcm)
	Get duration information of pcm. More...

NUGU_API int	nugu_pcm_get_position (NuguPcm *pcm)
	Get current playback position of pcm. More...

NUGU_API enum nugu_media_status	nugu_pcm_get_status (NuguPcm *pcm)
	Get status of pcm. More...

NUGU_API int	nugu_pcm_get_volume (NuguPcm *pcm)
	Get volume of pcm. More...

NUGU_API NuguPcm *	nugu_pcm_new (const char name, NuguPcmDriver driver, NuguAudioProperty property)
	Create new pcm object. More...

NUGU_API int	nugu_pcm_pause (NuguPcm *pcm)
	Pause pcm playback. More...

NUGU_API int	nugu_pcm_push_data (NuguPcm pcm, const char data, size_t size, int is_last)
	Push playback pcm data. More...

NUGU_API int	nugu_pcm_push_data_done (NuguPcm *pcm)
	Set flag that push for all data is complete. More...

NUGU_API int	nugu_pcm_receive_is_last_data (NuguPcm *pcm)
	Get flag that all data pushes are complete. More...

NUGU_API int	nugu_pcm_remove (NuguPcm *pcm)
	Remove pcm object from managed list. More...

NUGU_API int	nugu_pcm_resume (NuguPcm *pcm)
	Resume pcm playback. More...

NUGU_API int	nugu_pcm_set_audio_attribute (NuguPcm *pcm, NuguAudioAttribute attr)
	Set audio attribute. More...

NUGU_API int	nugu_pcm_set_driver_data (NuguPcm pcm, void data)
	Set custom data for driver. More...

NUGU_API void	nugu_pcm_set_event_callback (NuguPcm pcm, NuguMediaEventCallback cb, void userdata)
	Set pcm event callback. More...

NUGU_API void	nugu_pcm_set_status_callback (NuguPcm pcm, NuguMediaStatusCallback cb, void userdata)
	Set pcm status callback. More...

NUGU_API int	nugu_pcm_set_volume (NuguPcm *pcm, int volume)
	Set volume of pcm. More...

NUGU_API int	nugu_pcm_start (NuguPcm *pcm)
	Start pcm playback. More...

NUGU_API int	nugu_pcm_stop (NuguPcm *pcm)
	Stop pcm playback. More...

Detailed Description

PCM manipulation functions.

PCM data is managed by pushing it in the nugu buffer.

Function Documentation

◆ nugu_pcm_new()

NUGU_API NuguPcm* nugu_pcm_new	(	const char *	name,
		NuguPcmDriver *	driver,
		NuguAudioProperty	property
	)

Create new pcm object.

Parameters

[in]	name	pcm name
[in]	driver	driver object
[in]	property	audio property

Returns: pcm object

See also: nugu_pcm_driver_find(); nugu_pcm_driver_get_default(); nugu_pcm_free()

◆ nugu_pcm_free()

NUGU_API void nugu_pcm_free ( NuguPcm * pcm )

Destroy the pcm object.

Parameters

[in] pcm pcm object

See also: nugu_pcm_new()

◆ nugu_pcm_add()

NUGU_API int nugu_pcm_add ( NuguPcm * pcm )

Add pcm object to managed list.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_remove(); nugu_pcm_find()

◆ nugu_pcm_remove()

NUGU_API int nugu_pcm_remove ( NuguPcm * pcm )

Remove pcm object from managed list.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_add(); nugu_pcm_find()

◆ nugu_pcm_find()

NUGU_API NuguPcm* nugu_pcm_find ( const char * name )

Find a pcm object by name in the managed list.

Parameters

[in] name name of pcm object

Returns: pcm object

See also: nugu_pcm_add(); nugu_pcm_remove()

◆ nugu_pcm_set_audio_attribute()

NUGU_API int nugu_pcm_set_audio_attribute	(	NuguPcm *	pcm,
		NuguAudioAttribute	attr
	)

Set audio attribute.

Parameters

[in]	pcm	pcm object
[in]	attr	audio attribute

Returns: result

Return values

0	success
-1	failure

◆ nugu_pcm_get_audio_attribute()

NUGU_API int nugu_pcm_get_audio_attribute ( NuguPcm * pcm )

Get audio attribute.

Parameters

[in] pcm pcm object

Returns: audio attribute

Return values

-1 failure

◆ nugu_pcm_get_audio_attribute_str()

NUGU_API const char* nugu_pcm_get_audio_attribute_str ( NuguPcm * pcm )

Get audio attribute.

Parameters

[in] pcm pcm object

Returns: audio attribute string

Return values

NULL failure

◆ nugu_pcm_start()

NUGU_API int nugu_pcm_start ( NuguPcm * pcm )

Start pcm playback.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_stop()

◆ nugu_pcm_stop()

NUGU_API int nugu_pcm_stop ( NuguPcm * pcm )

Stop pcm playback.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_start()

◆ nugu_pcm_pause()

NUGU_API int nugu_pcm_pause ( NuguPcm * pcm )

Pause pcm playback.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_resume()

◆ nugu_pcm_resume()

NUGU_API int nugu_pcm_resume ( NuguPcm * pcm )

Resume pcm playback.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_pause()

◆ nugu_pcm_set_volume()

NUGU_API int nugu_pcm_set_volume	(	NuguPcm *	pcm,
		int	volume
	)

Set volume of pcm.

Parameters

[in]	pcm	pcm object
[in]	volume	volume

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_get_volume()

◆ nugu_pcm_get_volume()

NUGU_API int nugu_pcm_get_volume ( NuguPcm * pcm )

Get volume of pcm.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_set_volume()

◆ nugu_pcm_get_duration()

NUGU_API int nugu_pcm_get_duration ( NuguPcm * pcm )

Get duration information of pcm.

Parameters

[in] pcm pcm object

Returns: result

Return values

>0	success (duration)
-1	failure

◆ nugu_pcm_get_position()

NUGU_API int nugu_pcm_get_position ( NuguPcm * pcm )

Get current playback position of pcm.

Parameters

[in] pcm pcm object

Returns: result

Return values

>0	success (position)
-1	failure

◆ nugu_pcm_get_status()

NUGU_API enum nugu_media_status nugu_pcm_get_status ( NuguPcm * pcm )

Get status of pcm.

Parameters

[in] pcm pcm object

Returns: status

◆ nugu_pcm_set_status_callback()

NUGU_API void nugu_pcm_set_status_callback	(	NuguPcm *	pcm,
		NuguMediaStatusCallback	cb,
		void *	userdata
	)

Set pcm status callback.

Parameters

[in]	pcm	pcm object
[in]	cb	callback function
[in]	userdata	data to pass to the user callback

◆ nugu_pcm_emit_status()

NUGU_API void nugu_pcm_emit_status	(	NuguPcm *	pcm,
		enum nugu_media_status	status
	)

Emit status to registered callback.

Parameters

[in]	pcm	pcm object
[in]	status	pcm status

◆ nugu_pcm_set_event_callback()

NUGU_API void nugu_pcm_set_event_callback	(	NuguPcm *	pcm,
		NuguMediaEventCallback	cb,
		void *	userdata
	)

Set pcm event callback.

Parameters

[in]	pcm	pcm object
[in]	cb	callback function
[in]	userdata	data to pass to the user callback

◆ nugu_pcm_emit_event()

NUGU_API void nugu_pcm_emit_event	(	NuguPcm *	pcm,
		enum nugu_media_event	event
	)

Emit event to registered callback.

Parameters

[in]	pcm	pcm object
[in]	event	pcm event

◆ nugu_pcm_set_driver_data()

NUGU_API int nugu_pcm_set_driver_data	(	NuguPcm *	pcm,
		void *	data
	)

Set custom data for driver.

Parameters

[in]	pcm	pcm object
[in]	data	custom data managed by driver

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_get_driver_data()

◆ nugu_pcm_get_driver_data()

NUGU_API void* nugu_pcm_get_driver_data ( NuguPcm * pcm )

Get custom data for driver.

Parameters

[in] pcm pcm object

Returns: data

See also: nugu_pcm_set_driver_data()

◆ nugu_pcm_clear_buffer()

NUGU_API void nugu_pcm_clear_buffer ( NuguPcm * pcm )

Clear pcm buffer.

Parameters

[in] pcm pcm object

◆ nugu_pcm_push_data()

NUGU_API int nugu_pcm_push_data	(	NuguPcm *	pcm,
		const char *	data,
		size_t	size,
		int	is_last
	)

Push playback pcm data.

Parameters

[in]	pcm	pcm object
[in]	data	pcm data
[in]	size	length of pcm data
[in]	is_last	last data(is_last=1) or not(is_last=0)

Returns: result

Return values

0	success
-1	failure

◆ nugu_pcm_push_data_done()

NUGU_API int nugu_pcm_push_data_done ( NuguPcm * pcm )

Set flag that push for all data is complete.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_receive_is_last_data()

◆ nugu_pcm_get_data()

NUGU_API int nugu_pcm_get_data	(	NuguPcm *	pcm,
		char *	data,
		size_t	size
	)

Get all data.

Parameters

[in]	pcm	pcm object
[out]	data	buffer to get pcm data
[in]	size	size of buffer

Returns: result

Return values

0	success
-1	failure

◆ nugu_pcm_get_data_size()

NUGU_API size_t nugu_pcm_get_data_size ( NuguPcm * pcm )

Get pcm data size.

Parameters

[in] pcm pcm object

Returns: size of pcm data

◆ nugu_pcm_receive_is_last_data()

NUGU_API int nugu_pcm_receive_is_last_data ( NuguPcm * pcm )

Get flag that all data pushes are complete.

Parameters

[in] pcm pcm object

Returns: result

Return values

0	success
-1	failure

See also: nugu_pcm_push_data_done()

Typedefs

Functions

Detailed Description

Function Documentation

◆ nugu_pcm_new()

◆ nugu_pcm_free()

◆ nugu_pcm_add()

◆ nugu_pcm_remove()

◆ nugu_pcm_find()

◆ nugu_pcm_set_audio_attribute()

◆ nugu_pcm_get_audio_attribute()

◆ nugu_pcm_get_audio_attribute_str()

◆ nugu_pcm_start()

◆ nugu_pcm_stop()

◆ nugu_pcm_pause()

◆ nugu_pcm_resume()

◆ nugu_pcm_set_volume()

◆ nugu_pcm_get_volume()

◆ nugu_pcm_get_duration()

◆ nugu_pcm_get_position()

◆ nugu_pcm_get_status()

◆ nugu_pcm_set_status_callback()

◆ nugu_pcm_emit_status()

◆ nugu_pcm_set_event_callback()

◆ nugu_pcm_emit_event()

◆ nugu_pcm_set_driver_data()

◆ nugu_pcm_get_driver_data()

◆ nugu_pcm_clear_buffer()

◆ nugu_pcm_push_data()

◆ nugu_pcm_push_data_done()

◆ nugu_pcm_get_data()

◆ nugu_pcm_get_data_size()

◆ nugu_pcm_receive_is_last_data()