GI.GstAudio.Objects.AudioCdSrc

<para> Provides a base class for CD digital audio (CDDA) sources, which handles things like seeking, querying, discid calculation, tags, and buffer timestamping. </para> <refsect2> <title>Using GstAudioCdSrc-based elements in applications</title> <para> GstAudioCdSrc registers two Format<!-- -->s of its own, namely the "track" format and the "sector" format. Applications will usually only find the "track" format interesting. You can retrieve that Format for use in seek events or queries with gst_format_get_by_nick("track"). </para> <para> In order to query the number of tracks, for example, an application would set the CDDA source element to READY or PAUSED state and then query the the number of tracks via elementQueryDuration using the track format acquired above. Applications can query the currently playing track in the same way. </para> <para> Alternatively, applications may retrieve the currently playing track and the total number of tracks from the taglist that will posted on the bus whenever the CD is opened or the currently playing track changes. The taglist will contain GST_TAG_TRACK_NUMBER and GST_TAG_TRACK_COUNT tags. </para> <para> Applications playing back CD audio using playbin and cdda://n URIs should issue a seek command in track format to change between tracks, rather than setting a new cdda://n+1 URI on playbin (as setting a new URI on playbin involves closing and re-opening the CD device, which is much much slower). </para> <refsect2> </refsect2> <title>Tags and meta-information</title> <para> CDDA sources will automatically emit a number of tags, details about which can be found in the libgsttag documentation. Those tags are: TAG_CDDA_CDDB_DISCID, TAG_CDDA_CDDB_DISCID_FULL, TAG_CDDA_MUSICBRAINZ_DISCID, TAG_CDDA_MUSICBRAINZ_DISCID_FULL, among others. </para> </refsect2> <refsect2> <title>Tracks and Table of Contents (TOC)</title> <para> Applications will be informed of the available tracks via a TOC message on the pipeline's Bus. The Toc will contain a TocEntry for each track, with information about each track. The duration for each track can be retrieved via the TAG_DURATION tag from each entry's tag list, or calculated via tocEntryGetStartStopTimes. The track entries in the TOC will be sorted by track number. </para> </refsect2>

Exported types

newtype AudioCdSrc

Constructors

AudioCdSrc (ManagedPtr AudioCdSrc)

Instances

GObject AudioCdSrc

Methods

gobjectType :: AudioCdSrc -> IO GType

IsObject AudioCdSrc

IsURIHandler AudioCdSrc

IsElement AudioCdSrc

IsObject AudioCdSrc

IsPushSrc AudioCdSrc

IsBaseSrc AudioCdSrc

IsAudioCdSrc AudioCdSrc

((~) * info (ResolveAudioCdSrcMethod t AudioCdSrc), MethodInfo * info AudioCdSrc p) => IsLabel t (AudioCdSrc -> p)

Methods

fromLabel :: Proxy# Symbol t -> AudioCdSrc -> p

((~) * info (ResolveAudioCdSrcMethod t AudioCdSrc), MethodInfo * info AudioCdSrc p) => IsLabelProxy t (AudioCdSrc -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> AudioCdSrc -> p

HasAttributeList * AudioCdSrc

type AttributeList AudioCdSrc

type AttributeList AudioCdSrc

type SignalList AudioCdSrc

type SignalList AudioCdSrc

class GObject o => IsAudioCdSrc o

Instances

(GObject a, UnknownAncestorError Constraint AudioCdSrc a) => IsAudioCdSrc a

IsAudioCdSrc AudioCdSrc

toAudioCdSrc :: IsAudioCdSrc o => o -> IO AudioCdSrc

noAudioCdSrc :: Maybe AudioCdSrc

Methods

addTrack

data AudioCdSrcAddTrackMethodInfo

Instances

((~) * signature (AudioCdSrcTrack -> m Bool), MonadIO m, IsAudioCdSrc a) => MethodInfo * AudioCdSrcAddTrackMethodInfo a signature

Methods

overloadedMethod :: MethodProxy AudioCdSrcAddTrackMethodInfo a -> signature -> s

audioCdSrcAddTrack

Arguments

:: (HasCallStack, MonadIO m, IsAudioCdSrc a)

=> a

src: a AudioCdSrc

-> AudioCdSrcTrack

track: address of AudioCdSrcTrack to add

-> m Bool

Returns: FALSE on error, otherwise TRUE.

CDDA sources use this function from their start vfunc to announce the available data and audio tracks to the base source class. The caller should allocate track on the stack, the base source will do a shallow copy of the structure (and take ownership of the taglist if there is one).

Properties

device

data AudioCdSrcDevicePropertyInfo

Instances

AttrInfo AudioCdSrcDevicePropertyInfo

Associated Types

type AttrAllowedOps AudioCdSrcDevicePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AudioCdSrcDevicePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo :: * -> Constraint

type AttrGetType AudioCdSrcDevicePropertyInfo :: *

type AttrLabel AudioCdSrcDevicePropertyInfo :: Symbol

type AttrOrigin AudioCdSrcDevicePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo o => Proxy * AudioCdSrcDevicePropertyInfo -> o -> IO (AttrGetType AudioCdSrcDevicePropertyInfo)

attrSet :: (AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo o, AttrSetTypeConstraint AudioCdSrcDevicePropertyInfo b) => Proxy * AudioCdSrcDevicePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo o => Proxy * AudioCdSrcDevicePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo o, AttrSetTypeConstraint AudioCdSrcDevicePropertyInfo b) => Proxy * AudioCdSrcDevicePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AudioCdSrcDevicePropertyInfo

type AttrOrigin AudioCdSrcDevicePropertyInfo = AudioCdSrc

type AttrLabel AudioCdSrcDevicePropertyInfo

type AttrLabel AudioCdSrcDevicePropertyInfo = "device"

type AttrGetType AudioCdSrcDevicePropertyInfo

type AttrGetType AudioCdSrcDevicePropertyInfo = Maybe Text

type AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo

type AttrBaseTypeConstraint AudioCdSrcDevicePropertyInfo = IsAudioCdSrc

type AttrSetTypeConstraint AudioCdSrcDevicePropertyInfo

type AttrSetTypeConstraint AudioCdSrcDevicePropertyInfo = * ~ Text

type AttrAllowedOps AudioCdSrcDevicePropertyInfo

type AttrAllowedOps AudioCdSrcDevicePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

audioCdSrcDevice :: AttrLabelProxy "device"

clearAudioCdSrcDevice :: (MonadIO m, IsAudioCdSrc o) => o -> m ()

constructAudioCdSrcDevice :: IsAudioCdSrc o => Text -> IO (GValueConstruct o)

getAudioCdSrcDevice :: (MonadIO m, IsAudioCdSrc o) => o -> m (Maybe Text)

setAudioCdSrcDevice :: (MonadIO m, IsAudioCdSrc o) => o -> Text -> m ()

mode

data AudioCdSrcModePropertyInfo

Instances

AttrInfo AudioCdSrcModePropertyInfo

Associated Types

type AttrAllowedOps AudioCdSrcModePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AudioCdSrcModePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AudioCdSrcModePropertyInfo :: * -> Constraint

type AttrGetType AudioCdSrcModePropertyInfo :: *

type AttrLabel AudioCdSrcModePropertyInfo :: Symbol

type AttrOrigin AudioCdSrcModePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AudioCdSrcModePropertyInfo o => Proxy * AudioCdSrcModePropertyInfo -> o -> IO (AttrGetType AudioCdSrcModePropertyInfo)

attrSet :: (AttrBaseTypeConstraint AudioCdSrcModePropertyInfo o, AttrSetTypeConstraint AudioCdSrcModePropertyInfo b) => Proxy * AudioCdSrcModePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AudioCdSrcModePropertyInfo o => Proxy * AudioCdSrcModePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AudioCdSrcModePropertyInfo o, AttrSetTypeConstraint AudioCdSrcModePropertyInfo b) => Proxy * AudioCdSrcModePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AudioCdSrcModePropertyInfo

type AttrOrigin AudioCdSrcModePropertyInfo = AudioCdSrc

type AttrLabel AudioCdSrcModePropertyInfo

type AttrLabel AudioCdSrcModePropertyInfo = "mode"

type AttrGetType AudioCdSrcModePropertyInfo

type AttrGetType AudioCdSrcModePropertyInfo = AudioCdSrcMode

type AttrBaseTypeConstraint AudioCdSrcModePropertyInfo

type AttrBaseTypeConstraint AudioCdSrcModePropertyInfo = IsAudioCdSrc

type AttrSetTypeConstraint AudioCdSrcModePropertyInfo

type AttrSetTypeConstraint AudioCdSrcModePropertyInfo = * ~ AudioCdSrcMode

type AttrAllowedOps AudioCdSrcModePropertyInfo

type AttrAllowedOps AudioCdSrcModePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

audioCdSrcMode :: AttrLabelProxy "mode"

constructAudioCdSrcMode :: IsAudioCdSrc o => AudioCdSrcMode -> IO (GValueConstruct o)

getAudioCdSrcMode :: (MonadIO m, IsAudioCdSrc o) => o -> m AudioCdSrcMode

setAudioCdSrcMode :: (MonadIO m, IsAudioCdSrc o) => o -> AudioCdSrcMode -> m ()

track

data AudioCdSrcTrackPropertyInfo

Instances

AttrInfo AudioCdSrcTrackPropertyInfo

Associated Types

type AttrAllowedOps AudioCdSrcTrackPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint AudioCdSrcTrackPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo :: * -> Constraint

type AttrGetType AudioCdSrcTrackPropertyInfo :: *

type AttrLabel AudioCdSrcTrackPropertyInfo :: Symbol

type AttrOrigin AudioCdSrcTrackPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo o => Proxy * AudioCdSrcTrackPropertyInfo -> o -> IO (AttrGetType AudioCdSrcTrackPropertyInfo)

attrSet :: (AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo o, AttrSetTypeConstraint AudioCdSrcTrackPropertyInfo b) => Proxy * AudioCdSrcTrackPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo o => Proxy * AudioCdSrcTrackPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo o, AttrSetTypeConstraint AudioCdSrcTrackPropertyInfo b) => Proxy * AudioCdSrcTrackPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin AudioCdSrcTrackPropertyInfo

type AttrOrigin AudioCdSrcTrackPropertyInfo = AudioCdSrc

type AttrLabel AudioCdSrcTrackPropertyInfo

type AttrLabel AudioCdSrcTrackPropertyInfo = "track"

type AttrGetType AudioCdSrcTrackPropertyInfo

type AttrGetType AudioCdSrcTrackPropertyInfo = Word32

type AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo

type AttrBaseTypeConstraint AudioCdSrcTrackPropertyInfo = IsAudioCdSrc

type AttrSetTypeConstraint AudioCdSrcTrackPropertyInfo

type AttrSetTypeConstraint AudioCdSrcTrackPropertyInfo = * ~ Word32

type AttrAllowedOps AudioCdSrcTrackPropertyInfo

type AttrAllowedOps AudioCdSrcTrackPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

audioCdSrcTrack :: AttrLabelProxy "track"

constructAudioCdSrcTrack :: IsAudioCdSrc o => Word32 -> IO (GValueConstruct o)

getAudioCdSrcTrack :: (MonadIO m, IsAudioCdSrc o) => o -> m Word32

setAudioCdSrcTrack :: (MonadIO m, IsAudioCdSrc o) => o -> Word32 -> m ()