libcdio  2.1.0
Data Structures | Typedefs | Functions
audio.h File Reference

The top-level header for CD audio-related libcdio calls. These control playing of the CD-ROM through its line-out jack. More...

#include <cdio/types.h>

Go to the source code of this file.

Data Structures

struct  cdio_subchannel_s
 
struct  cdio_audio_volume_s
 
struct  cdio_track_index_s
 

Typedefs

typedef struct cdio_subchannel_s cdio_subchannel_t
 
typedef struct cdio_audio_volume_s cdio_audio_volume_t
 
typedef struct cdio_track_index_s cdio_track_index_t
 

Functions

driver_return_code_t cdio_audio_get_volume (CdIo_t *p_cdio, cdio_audio_volume_t *p_volume)
 
uint32_t cdio_audio_get_msf_seconds (msf_t *p_msf)
 
driver_return_code_t cdio_audio_pause (CdIo_t *p_cdio)
 
driver_return_code_t cdio_audio_play_msf (CdIo_t *p_cdio, msf_t *p_start_msf, msf_t *p_end_msf)
 
driver_return_code_t cdio_audio_play_track_index (CdIo_t *p_cdio, cdio_track_index_t *p_track_index)
 
driver_return_code_t cdio_audio_read_subchannel (CdIo_t *p_cdio, cdio_subchannel_t *p_subchannel)
 
driver_return_code_t cdio_audio_resume (CdIo_t *p_cdio)
 
driver_return_code_t cdio_audio_set_volume (CdIo_t *p_cdio, cdio_audio_volume_t *p_volume)
 
driver_return_code_t cdio_audio_stop (CdIo_t *p_cdio)
 

Detailed Description

The top-level header for CD audio-related libcdio calls. These control playing of the CD-ROM through its line-out jack.

Typedef Documentation

◆ cdio_audio_volume_t

This struct is used by cdio_audio_get_volume and cdio_audio_set_volume

◆ cdio_subchannel_t

This struct is used by the cdio_audio_read_subchannel

◆ cdio_track_index_t

This struct is used by the CDROMPLAYTRKIND ioctl

Function Documentation

◆ cdio_audio_get_msf_seconds()

uint32_t cdio_audio_get_msf_seconds ( msf_t p_msf)

Return the number of seconds (discarding frame portion) of an MSF

◆ cdio_audio_get_volume()

driver_return_code_t cdio_audio_get_volume ( CdIo_t p_cdio,
cdio_audio_volume_t p_volume 
)

Get volume of an audio CD.

Parameters
p_cdiothe CD object to be acted upon.
p_volumeplace to put the list of volume outputs levels

p_volume can be NULL in which case we return only whether the driver has the ability to get the volume or not.

◆ cdio_audio_pause()

driver_return_code_t cdio_audio_pause ( CdIo_t p_cdio)

Pause playing CD through analog output

Parameters
p_cdiothe CD object to be acted upon.

◆ cdio_audio_play_msf()

driver_return_code_t cdio_audio_play_msf ( CdIo_t p_cdio,
msf_t p_start_msf,
msf_t p_end_msf 
)

Playing CD through analog output at the given MSF.

Parameters
p_cdiothe CD object to be acted upon.
p_start_msfpointer to staring MSF
p_end_msfpointer to ending MSF

◆ cdio_audio_play_track_index()

driver_return_code_t cdio_audio_play_track_index ( CdIo_t p_cdio,
cdio_track_index_t p_track_index 
)

Playing CD through analog output at the desired track and index

Parameters
p_cdiothe CD object to be acted upon.
p_track_indexlocation to start/end.

◆ cdio_audio_read_subchannel()

driver_return_code_t cdio_audio_read_subchannel ( CdIo_t p_cdio,
cdio_subchannel_t p_subchannel 
)

Get subchannel information.

Parameters
p_cdiothe CD object to be acted upon.
p_subchannelplace for returned subchannel information

◆ cdio_audio_resume()

driver_return_code_t cdio_audio_resume ( CdIo_t p_cdio)

Resume playing an audio CD.

Parameters
p_cdiothe CD object to be acted upon.

◆ cdio_audio_set_volume()

driver_return_code_t cdio_audio_set_volume ( CdIo_t p_cdio,
cdio_audio_volume_t p_volume 
)

Set volume of an audio CD.

Parameters
p_cdiothe CD object to be acted upon.
p_volumeplace for returned volume-level information

◆ cdio_audio_stop()

driver_return_code_t cdio_audio_stop ( CdIo_t p_cdio)

Stop playing an audio CD.

Parameters
p_cdiothe CD object to be acted upon.